// Part of the Carbon Language project, under the Apache License v2.0 with LLVM // Exceptions. See /LICENSE for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include "testing/file_test/file_test_base.h" #include #include #include #include #include #include "absl/flags/flag.h" #include "absl/flags/parse.h" #include "common/check.h" #include "common/error.h" #include "llvm/ADT/StringExtras.h" #include "llvm/ADT/Twine.h" #include "llvm/Support/FormatVariadic.h" #include "llvm/Support/InitLLVM.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/PrettyStackTrace.h" #include "llvm/Support/Process.h" #include "llvm/Support/ThreadPool.h" #include "testing/file_test/autoupdate.h" ABSL_FLAG(std::vector, file_tests, {}, "A comma-separated list of repo-relative names of test files. " "Overrides test_targets_file."); ABSL_FLAG(std::string, test_targets_file, "", "A path to a file containing repo-relative names of test files."); ABSL_FLAG(bool, autoupdate, false, "Instead of verifying files match test output, autoupdate files " "based on test output."); ABSL_FLAG(unsigned int, threads, 0, "Number of threads to use when autoupdating tests, or 0 to " "automatically determine a thread count."); namespace Carbon::Testing { using ::testing::Eq; using ::testing::Matcher; using ::testing::MatchesRegex; using ::testing::StrEq; // Reads a file to string. static auto ReadFile(std::string_view path) -> std::string { std::ifstream proto_file(path); std::stringstream buffer; buffer << proto_file.rdbuf(); proto_file.close(); return buffer.str(); } // Splits outputs to string_view because gtest handles string_view by default. static auto SplitOutput(llvm::StringRef output) -> llvm::SmallVector { if (output.empty()) { return {}; } llvm::SmallVector lines; llvm::StringRef(output).split(lines, "\n"); return llvm::SmallVector(lines.begin(), lines.end()); } // Runs a test and compares output. This keeps output split by line so that // issues are a little easier to identify by the different line. auto FileTestBase::TestBody() -> void { std::optional stack_trace_entry; // If we're being run from bazel, provide some assistance for understanding // and reproducing failures. const char* target = getenv("TEST_TARGET"); if (target) { // This advice overrides the --file_tests flag provided by the file_test // rule. llvm::errs() << "\nTo test this file alone, run:\n bazel test " << target << " --test_arg=--file_tests=" << test_name_ << "\n\n"; // Add a crash trace entry with a command that runs this test in isolation. stack_trace_entry.emplace("bazel test %s --test_arg=--file_tests=%s", target, test_name_); } TestContext context; auto run_result = ProcessTestFileAndRun(context); ASSERT_TRUE(run_result.ok()) << run_result.error(); ValidateRun(); auto test_filename = std::filesystem::path(test_name_.str()).filename(); EXPECT_THAT(!llvm::StringRef(test_filename).starts_with("fail_"), Eq(context.exit_with_success)) << "Tests should be prefixed with `fail_` if and only if running them " "is expected to fail."; // Check results. Include a reminder of the autoupdate command for any // stdout/stderr differences. std::string update_message; if (target && context.autoupdate_line_number) { update_message = llvm::formatv( "If these differences are expected, try the autoupdater:\n" "\tbazel run {0} -- --autoupdate --file_tests={1}", target, test_name_); } else { update_message = "If these differences are expected, content must be updated manually."; } SCOPED_TRACE(update_message); if (context.check_subset) { EXPECT_THAT(SplitOutput(context.stdout), IsSupersetOf(context.expected_stdout)); EXPECT_THAT(SplitOutput(context.stderr), IsSupersetOf(context.expected_stderr)); } else { EXPECT_THAT(SplitOutput(context.stdout), ElementsAreArray(context.expected_stdout)); EXPECT_THAT(SplitOutput(context.stderr), ElementsAreArray(context.expected_stderr)); } // If there are no other test failures, check if autoupdate would make // changes. We don't do this when there _are_ failures because the // SCOPED_TRACE already contains the autoupdate reminder. if (!HasFailure() && RunAutoupdater(context, /*dry_run=*/true)) { ADD_FAILURE() << "Autoupdate would make changes to the file content."; } } auto FileTestBase::RunAutoupdater(const TestContext& context, bool dry_run) -> bool { if (!context.autoupdate_line_number) { return false; } llvm::SmallVector filenames; filenames.reserve(context.non_check_lines.size()); if (context.has_splits) { // There are splits, so we provide an empty name for the first file. filenames.push_back({}); } for (const auto& file : context.test_files) { filenames.push_back(file.filename); } llvm::ArrayRef expected_filenames = filenames; if (filenames.size() > 1) { expected_filenames = expected_filenames.drop_front(); } return FileTestAutoupdater( std::filesystem::absolute(test_name_.str()), context.input_content, filenames, *context.autoupdate_line_number, context.non_check_lines, context.stdout, context.stderr, GetDefaultFileRE(expected_filenames), GetLineNumberReplacements(expected_filenames), [&](std::string& line) { DoExtraCheckReplacements(line); }) .Run(dry_run); } auto FileTestBase::Autoupdate() -> ErrorOr { // Add a crash trace entry mentioning which file we're updating. llvm::PrettyStackTraceFormat stack_trace_entry("performing autoupdate for %s", test_name_); TestContext context; auto run_result = ProcessTestFileAndRun(context); if (!run_result.ok()) { return ErrorBuilder() << "Error updating " << test_name_ << ": " << run_result.error(); } return RunAutoupdater(context, /*dry_run=*/false); } auto FileTestBase::GetLineNumberReplacements( llvm::ArrayRef filenames) -> llvm::SmallVector { return {{.has_file = true, .re = std::make_shared( llvm::formatv(R"(({0}):(\d+))", llvm::join(filenames, "|"))), .line_formatv = R"({0})"}}; } auto FileTestBase::ProcessTestFileAndRun(TestContext& context) -> ErrorOr { // Store the file so that test_files can use references to content. context.input_content = ReadFile(test_name_); // Load expected output. CARBON_RETURN_IF_ERROR(ProcessTestFile(context)); // Process arguments. if (context.test_args.empty()) { context.test_args = GetDefaultArgs(); } CARBON_RETURN_IF_ERROR( DoArgReplacements(context.test_args, context.test_files)); // Create the files in-memory. llvm::vfs::InMemoryFileSystem fs; for (const auto& test_file : context.test_files) { if (!fs.addFile(test_file.filename, /*ModificationTime=*/0, llvm::MemoryBuffer::getMemBuffer( test_file.content, test_file.filename, /*RequiresNullTerminator=*/false))) { return ErrorBuilder() << "File is repeated: " << test_file.filename; } } // Convert the arguments to StringRef and const char* to match the // expectations of PrettyStackTraceProgram and Run. llvm::SmallVector test_args_ref; llvm::SmallVector test_argv_for_stack_trace; test_args_ref.reserve(context.test_args.size()); test_argv_for_stack_trace.reserve(context.test_args.size() + 1); for (const auto& arg : context.test_args) { test_args_ref.push_back(arg); test_argv_for_stack_trace.push_back(arg.c_str()); } // Add a trailing null so that this is a proper argv. test_argv_for_stack_trace.push_back(nullptr); // Add a stack trace entry for the test invocation. llvm::PrettyStackTraceProgram stack_trace_entry( test_argv_for_stack_trace.size() - 1, test_argv_for_stack_trace.data()); // Capture trace streaming, but only when in debug mode. llvm::raw_svector_ostream stdout(context.stdout); llvm::raw_svector_ostream stderr(context.stderr); CARBON_ASSIGN_OR_RETURN(context.exit_with_success, Run(test_args_ref, fs, stdout, stderr)); return Success(); } auto FileTestBase::DoArgReplacements( llvm::SmallVector& test_args, const llvm::SmallVector& test_files) -> ErrorOr { for (auto* it = test_args.begin(); it != test_args.end(); ++it) { auto percent = it->find("%"); if (percent == std::string::npos) { continue; } if (percent + 1 >= it->size()) { return ErrorBuilder() << "% is not allowed on its own: " << *it; } char c = (*it)[percent + 1]; switch (c) { case 's': { if (*it != "%s") { return ErrorBuilder() << "%s must be the full argument: " << *it; } it = test_args.erase(it); for (const auto& file : test_files) { it = test_args.insert(it, file.filename); ++it; } // Back up once because the for loop will advance. --it; break; } case 't': { char* tmpdir = getenv("TEST_TMPDIR"); CARBON_CHECK(tmpdir != nullptr); it->replace(percent, 2, llvm::formatv("{0}/temp_file", tmpdir)); break; } default: return ErrorBuilder() << "%" << c << " is not supported: " << *it; } } return Success(); } // Processes conflict markers, including tracking of whether code is within a // conflict marker. Returns true if the line is consumed. static auto TryConsumeConflictMarker(llvm::StringRef line, llvm::StringRef line_trimmed, bool* inside_conflict_marker) -> ErrorOr { bool is_start = line.starts_with("<<<<<<<"); bool is_middle = line.starts_with("======="); bool is_end = line.starts_with(">>>>>>>"); // When running the test, any conflict marker is an error. if (!absl::GetFlag(FLAGS_autoupdate) && (is_start || is_middle || is_end)) { return ErrorBuilder() << "Conflict marker found:\n" << line; } // Autoupdate tracks conflict markers for context, and will discard // conflicting lines when it can autoupdate them. if (*inside_conflict_marker) { if (is_start) { return ErrorBuilder() << "Unexpected conflict marker inside conflict:\n" << line; } if (is_middle) { return true; } if (is_end) { *inside_conflict_marker = false; return true; } // Look for CHECK lines, which can be discarded. if (line_trimmed.starts_with("// CHECK:STDOUT:") || line_trimmed.starts_with("// CHECK:STDERR:")) { return true; } return ErrorBuilder() << "Autoupdate can't discard non-CHECK lines inside conflicts:\n" << line; } else { if (is_start) { *inside_conflict_marker = true; return true; } if (is_middle || is_end) { return ErrorBuilder() << "Unexpected conflict marker outside conflict:\n" << line; } return false; } } // State for file splitting logic: TryConsumeSplit and FinishSplit. struct SplitState { auto has_splits() const -> bool { return file_index > 0; } auto add_content(llvm::StringRef line) -> void { content.append(line); content.append("\n"); } // Whether content has been found. Only updated before a file split is found // (which may be never). bool found_code_pre_split = false; // The current file name, considering splits. Empty for the default file. llvm::StringRef filename = ""; // The accumulated content for the file being built. This may elide some of // the original content, such as conflict markers. std::string content; // The current file index. int file_index = 0; }; // Adds a file. Used for both split and unsplit test files. static auto AddTestFile(llvm::StringRef filename, std::string* content, llvm::SmallVector* test_files) -> void { test_files->push_back( {.filename = filename.str(), .content = std::move(*content)}); content->clear(); } // Process file split ("---") lines when found. Returns true if the line is // consumed. static auto TryConsumeSplit( llvm::StringRef line, llvm::StringRef line_trimmed, bool found_autoupdate, int* line_index, SplitState* split, llvm::SmallVector* test_files, llvm::SmallVector* non_check_lines) -> ErrorOr { if (!line_trimmed.consume_front("// ---")) { if (!split->has_splits() && !line_trimmed.starts_with("//") && !line_trimmed.empty()) { split->found_code_pre_split = true; } // Add the line to the current file's content (which may not be a split // file). split->add_content(line); return false; } if (!found_autoupdate) { // If there's a split, all output is appended at the end of each file // before AUTOUPDATE. We may want to change that, but it's not // necessary to handle right now. return ErrorBuilder() << "AUTOUPDATE/NOAUTOUPDATE setting must be in " "the first file."; } // On a file split, add the previous file, then start a new one. if (split->has_splits()) { AddTestFile(split->filename, &split->content, test_files); } else { split->content.clear(); if (split->found_code_pre_split) { // For the first split, we make sure there was no content prior. return ErrorBuilder() << "When using split files, there must be no " "content before the first split file."; } } ++split->file_index; split->filename = line_trimmed.trim(); if (split->filename.empty()) { return ErrorBuilder() << "Missing filename for split."; } // The split line is added to non_check_lines for retention in autoupdate, but // is not added to the test file content. *line_index = 0; non_check_lines->push_back( FileTestLine(split->file_index, *line_index, line)); return true; } // Transforms an expectation on a given line from `FileCheck` syntax into a // standard regex matcher. static auto TransformExpectation(int line_index, llvm::StringRef in) -> ErrorOr> { if (in.empty()) { return Matcher{StrEq("")}; } if (in[0] != ' ') { return ErrorBuilder() << "Malformated CHECK line: " << in; } std::string str = in.substr(1).str(); for (int pos = 0; pos < static_cast(str.size());) { switch (str[pos]) { case '(': case ')': case ']': case '}': case '.': case '^': case '$': case '*': case '+': case '?': case '|': case '\\': { // Escape regex characters. str.insert(pos, "\\"); pos += 2; break; } case '[': { llvm::StringRef line_keyword_cursor = llvm::StringRef(str).substr(pos); if (line_keyword_cursor.consume_front("[[")) { static constexpr llvm::StringLiteral LineKeyword = "@LINE"; if (line_keyword_cursor.consume_front(LineKeyword)) { // Allow + or - here; consumeInteger handles -. line_keyword_cursor.consume_front("+"); int offset; // consumeInteger returns true for errors, not false. if (line_keyword_cursor.consumeInteger(10, offset) || !line_keyword_cursor.consume_front("]]")) { return ErrorBuilder() << "Unexpected @LINE offset at `" << line_keyword_cursor.substr(0, 5) << "` in: " << in; } std::string int_str = llvm::Twine(line_index + offset).str(); int remove_len = (line_keyword_cursor.data() - str.data()) - pos; str.replace(pos, remove_len, int_str); pos += int_str.size(); } else { return ErrorBuilder() << "Unexpected [[, should be {{\\[\\[}} at `" << line_keyword_cursor.substr(0, 5) << "` in: " << in; } } else { // Escape the `[`. str.insert(pos, "\\"); pos += 2; } break; } case '{': { if (pos + 1 == static_cast(str.size()) || str[pos + 1] != '{') { // Single `{`, escape it. str.insert(pos, "\\"); pos += 2; } else { // Replace the `{{...}}` regex syntax with standard `(...)` syntax. str.replace(pos, 2, "("); for (++pos; pos < static_cast(str.size() - 1); ++pos) { if (str[pos] == '}' && str[pos + 1] == '}') { str.replace(pos, 2, ")"); ++pos; break; } } } break; } default: { ++pos; } } } return Matcher{MatchesRegex(str)}; } // Once all content is processed, do any remaining split processing. static auto FinishSplit(llvm::StringRef test_name, SplitState* split, llvm::SmallVector* test_files) -> void { if (split->has_splits()) { AddTestFile(split->filename, &split->content, test_files); } else { // If no file splitting happened, use the main file as the test file. // There will always be a `/` unless tests are in the repo root. AddTestFile(test_name.drop_front(test_name.rfind("/") + 1), &split->content, test_files); } } // Process CHECK lines when found. Returns true if the line is consumed. static auto TryConsumeCheck( int line_index, llvm::StringRef line, llvm::StringRef line_trimmed, llvm::SmallVector>* expected_stdout, llvm::SmallVector>* expected_stderr) -> ErrorOr { if (!line_trimmed.consume_front("// CHECK")) { return false; } // Don't build expectations when doing an autoupdate. We don't want to // break the autoupdate on an invalid CHECK line. if (!absl::GetFlag(FLAGS_autoupdate)) { llvm::SmallVector>* expected; if (line_trimmed.consume_front(":STDOUT:")) { expected = expected_stdout; } else if (line_trimmed.consume_front(":STDERR:")) { expected = expected_stderr; } else { return ErrorBuilder() << "Unexpected CHECK in input: " << line.str(); } CARBON_ASSIGN_OR_RETURN(Matcher check_matcher, TransformExpectation(line_index, line_trimmed)); expected->push_back(check_matcher); } return true; } // Processes ARGS lines when found. Returns true if the line is consumed. static auto TryConsumeArgs(llvm::StringRef line, llvm::StringRef line_trimmed, llvm::SmallVector* args) -> ErrorOr { if (!line_trimmed.consume_front("// ARGS: ")) { return false; } if (!args->empty()) { return ErrorBuilder() << "ARGS was specified multiple times: " << line.str(); } // Split the line into arguments. std::pair cursor = llvm::getToken(line_trimmed); while (!cursor.first.empty()) { args->push_back(std::string(cursor.first)); cursor = llvm::getToken(cursor.second); } return true; } // Processes AUTOUPDATE lines when found. Returns true if the line is consumed. static auto TryConsumeAutoupdate(int line_index, llvm::StringRef line_trimmed, bool* found_autoupdate, std::optional* autoupdate_line_number) -> ErrorOr { static constexpr llvm::StringLiteral Autoupdate = "// AUTOUPDATE"; static constexpr llvm::StringLiteral NoAutoupdate = "// NOAUTOUPDATE"; if (line_trimmed != Autoupdate && line_trimmed != NoAutoupdate) { return false; } if (*found_autoupdate) { return ErrorBuilder() << "Multiple AUTOUPDATE/NOAUTOUPDATE settings found"; } *found_autoupdate = true; if (line_trimmed == Autoupdate) { *autoupdate_line_number = line_index; } return true; } // Processes SET-CHECK-SUBSET lines when found. Returns true if the line is // consumed. static auto TryConsumeSetCheckSubset(llvm::StringRef line_trimmed, bool* check_subset) -> ErrorOr { if (line_trimmed != "// SET-CHECK-SUBSET") { return false; } if (*check_subset) { return ErrorBuilder() << "SET-CHECK-SUBSET was specified multiple times"; } *check_subset = true; return true; } auto FileTestBase::ProcessTestFile(TestContext& context) -> ErrorOr { // Original file content, and a cursor for walking through it. llvm::StringRef file_content = context.input_content; llvm::StringRef cursor = file_content; // Whether either AUTOUDPATE or NOAUTOUPDATE was found. bool found_autoupdate = false; // The index in the current test file. Will be reset on splits. int line_index = 0; SplitState split; // When autoupdating, we track whether we're inside conflict markers. // Otherwise conflict markers are errors. bool inside_conflict_marker = false; while (!cursor.empty()) { auto [line, next_cursor] = cursor.split("\n"); cursor = next_cursor; auto line_trimmed = line.ltrim(); bool is_consumed = false; CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeConflictMarker(line, line_trimmed, &inside_conflict_marker)); if (is_consumed) { continue; } // At this point, remaining lines are part of the test input. CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeSplit(line, line_trimmed, found_autoupdate, &line_index, &split, &context.test_files, &context.non_check_lines)); if (is_consumed) { continue; } ++line_index; CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeCheck(line_index, line, line_trimmed, &context.expected_stdout, &context.expected_stderr)); if (is_consumed) { continue; } // At this point, lines are retained as non-CHECK lines. context.non_check_lines.push_back( FileTestLine(split.file_index, line_index, line)); CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeArgs(line, line_trimmed, &context.test_args)); if (is_consumed) { continue; } CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeAutoupdate(line_index, line_trimmed, &found_autoupdate, &context.autoupdate_line_number)); if (is_consumed) { continue; } CARBON_ASSIGN_OR_RETURN( is_consumed, TryConsumeSetCheckSubset(line_trimmed, &context.check_subset)); if (is_consumed) { continue; } } if (!found_autoupdate) { return ErrorBuilder() << "Missing AUTOUPDATE/NOAUTOUPDATE setting"; } context.has_splits = split.has_splits(); FinishSplit(test_name_, &split, &context.test_files); // Assume there is always a suffix `\n` in output. if (!context.expected_stdout.empty()) { context.expected_stdout.push_back(StrEq("")); } if (!context.expected_stderr.empty()) { context.expected_stderr.push_back(StrEq("")); } return Success(); } // Returns the tests to run. static auto GetTests() -> llvm::SmallVector { // Prefer a user-specified list if present. auto specific_tests = absl::GetFlag(FLAGS_file_tests); if (!specific_tests.empty()) { return llvm::SmallVector(specific_tests.begin(), specific_tests.end()); } // Extracts tests from the target file. CARBON_CHECK(!absl::GetFlag(FLAGS_test_targets_file).empty()) << "Missing --test_targets_file."; auto content = ReadFile(absl::GetFlag(FLAGS_test_targets_file)); llvm::SmallVector all_tests; for (llvm::StringRef file_ref : llvm::split(content, "\n")) { if (file_ref.empty()) { continue; } all_tests.push_back(file_ref.str()); } return all_tests; } // Implements main() within the Carbon::Testing namespace for convenience. static auto Main(int argc, char** argv) -> int { absl::ParseCommandLine(argc, argv); testing::InitGoogleTest(&argc, argv); llvm::setBugReportMsg( "Please report issues to " "https://github.com/carbon-language/carbon-lang/issues and include the " "crash backtrace.\n"); llvm::InitLLVM init_llvm(argc, argv); if (argc > 1) { llvm::errs() << "Unexpected arguments starting at: " << argv[1] << "\n"; return EXIT_FAILURE; } // Tests might try to read from stdin. Ensure those reads fail by closing // stdin and reopening it as /dev/null. Note that STDIN_FILENO doesn't exist // on Windows, but POSIX requires it to be 0. llvm::sys::Process::SafelyCloseFileDescriptor(0); llvm::sys::Process::FixupStandardFileDescriptors(); llvm::SmallVector tests = GetTests(); auto test_factory = GetFileTestFactory(); if (absl::GetFlag(FLAGS_autoupdate)) { llvm::ThreadPool pool({.ThreadsRequested = absl::GetFlag(FLAGS_threads)}); std::mutex errs_mutex; for (const auto& test_name : tests) { pool.async([&test_factory, &errs_mutex, test_name] { std::unique_ptr test(test_factory.factory_fn(test_name)); auto result = test->Autoupdate(); // Guard access to llvm::errs, which is not thread-safe. std::unique_lock lock(errs_mutex); if (result.ok()) { llvm::errs() << (*result ? "!" : "."); } else { llvm::errs() << "\n" << result.error().message() << "\n"; } }); } pool.wait(); llvm::errs() << "\nDone!\n"; return EXIT_SUCCESS; } else { for (llvm::StringRef test_name : tests) { testing::RegisterTest(test_factory.name, test_name.data(), nullptr, test_name.data(), __FILE__, __LINE__, [&test_factory, test_name = test_name]() { return test_factory.factory_fn(test_name); }); } return RUN_ALL_TESTS(); } } } // namespace Carbon::Testing auto main(int argc, char** argv) -> int { return Carbon::Testing::Main(argc, argv); }