mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 08:01:05 +01:00
Jon Ross-Perkins
6b7a522b3f
The intent of this change is that instead of paths looking like `explorer/testdata/foo/bar.carbon` (repo-relative), they're now just `bar.carbon` (local). The consequence is that paths should be a bit more durable in various environments, and just paths should be shorter and easier to read. The explorer's prelude is an exception to this since it comes from data, rather than being the test target. Due to the change in approaches, it needs the regex again. Uses #2829
74 lines
2.7 KiB
C++
74 lines
2.7 KiB
C++
// 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
|
|
|
|
#ifndef CARBON_TESTING_FILE_TEST_FILE_TEST_BASE_H_
|
|
#define CARBON_TESTING_FILE_TEST_FILE_TEST_BASE_H_
|
|
|
|
#include <gmock/gmock.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
#include <filesystem>
|
|
#include <functional>
|
|
#include <vector>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
namespace Carbon::Testing {
|
|
|
|
// A framework for testing files. Children implement `RegisterTestFiles` with
|
|
// calls to `RegisterTests` using a factory that constructs the child.
|
|
// `RunOverFile` must also be implemented and will be called as part of
|
|
// individual test executions. This framework includes a `main` implementation,
|
|
// so users must not provide one.
|
|
//
|
|
// Tests should have CHECK lines similar to `FileCheck` syntax:
|
|
// https://llvm.org/docs/CommandGuide/FileCheck.html
|
|
//
|
|
// Special nuances are that stdout and stderr will look like `// CHECK:STDOUT:
|
|
// ...` and `// CHECK:STDERR: ...` respectively. `[[@LINE+offset]` and
|
|
// `{{regex}}` syntaxes should also work.
|
|
//
|
|
// `lit_autoupdate.py` automatically constructs compatible lines.
|
|
class FileTestBase : public testing::Test {
|
|
public:
|
|
explicit FileTestBase(const std::filesystem::path& path);
|
|
~FileTestBase() override;
|
|
|
|
// Used by children to register tests with gtest.
|
|
static void RegisterTests(
|
|
const char* fixture_label,
|
|
const std::vector<std::filesystem::path>& paths,
|
|
std::function<FileTestBase*(const std::filesystem::path&)> factory);
|
|
|
|
// Implemented by children to run the test. Called by the TestBody
|
|
// implementation, which will validate stdout and stderr. The return value
|
|
// should be false when "fail_" is in the filename.
|
|
virtual auto RunOverFile(llvm::raw_ostream& stdout, llvm::raw_ostream& stderr)
|
|
-> bool = 0;
|
|
|
|
// 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 TestBody() -> void final;
|
|
|
|
// Returns the full path of the file being tested.
|
|
auto path() -> const std::filesystem::path& { return *path_; };
|
|
|
|
private:
|
|
// Transforms an expectation on a given line from `FileCheck` syntax into a
|
|
// standard regex matcher.
|
|
static auto TransformExpectation(int line_index, llvm::StringRef in)
|
|
-> testing::Matcher<std::string>;
|
|
|
|
const std::filesystem::path* path_;
|
|
};
|
|
|
|
// Must be implemented by the individual file_test to initialize tests.
|
|
extern auto RegisterFileTests(const std::vector<std::filesystem::path>& paths)
|
|
-> void;
|
|
|
|
} // namespace Carbon::Testing
|
|
|
|
#endif // CARBON_TESTING_FILE_TEST_FILE_TEST_BASE_H_
|