mirror of
https://github.com/pybind/pybind11.git
synced 2026-07-15 19:44:01 +00:00
1014ee403f
Add a custom Catch2 streaming reporter that prints one line per test case as it starts and ends, with immediate flushing to keep CI logs current. This makes it easy to see where the embedded/interpreter tests are spending time and to pinpoint which test case is stuck when builds hang (e.g., free-threading issues). The reporter: - Prints "[ RUN ]" when each test starts - Prints "[ OK ]" or "[ FAILED ]" when each test ends - Prints the Python version once at the start via Py_GetVersion() - Uses StreamingReporterBase for immediate output (not buffered) - Is set as the default reporter via CATCH_CONFIG_DEFAULT_REPORTER This approach gives visibility into all tests without changing their behavior, turning otherwise opaque 90-minute CI timeouts into locatable issues in the Catch output.
102 lines
3.0 KiB
C++
102 lines
3.0 KiB
C++
// The Catch implementation is compiled here. This is a standalone
|
|
// translation unit to avoid recompiling it for every test change.
|
|
|
|
#include <pybind11/embed.h>
|
|
|
|
// Silence MSVC C++17 deprecation warning from Catch regarding std::uncaught_exceptions (up to
|
|
// catch 2.0.1; this should be fixed in the next catch release after 2.0.1).
|
|
PYBIND11_WARNING_DISABLE_MSVC(4996)
|
|
|
|
// Catch uses _ internally, which breaks gettext style defines
|
|
#ifdef _
|
|
# undef _
|
|
#endif
|
|
|
|
#define CATCH_CONFIG_RUNNER
|
|
#define CATCH_CONFIG_DEFAULT_REPORTER "progress"
|
|
#include <catch.hpp>
|
|
|
|
namespace py = pybind11;
|
|
|
|
// Simple progress reporter that prints a line per test case.
|
|
namespace {
|
|
|
|
class ProgressReporter : public Catch::StreamingReporterBase<ProgressReporter> {
|
|
public:
|
|
using StreamingReporterBase<ProgressReporter>::StreamingReporterBase;
|
|
|
|
static std::string getDescription() { return "Simple progress reporter (one line per test)"; }
|
|
|
|
void testCaseStarting(Catch::TestCaseInfo const &testInfo) override {
|
|
print_python_version_once();
|
|
auto &os = Catch::cout();
|
|
os << "[ RUN ] " << testInfo.name << '\n';
|
|
os.flush();
|
|
}
|
|
|
|
void testCaseEnded(Catch::TestCaseStats const &stats) override {
|
|
bool failed = stats.totals.assertions.failed > 0;
|
|
auto &os = Catch::cout();
|
|
os << (failed ? "[ FAILED ] " : "[ OK ] ") << stats.testInfo.name << '\n';
|
|
os.flush();
|
|
}
|
|
|
|
void noMatchingTestCases(std::string const &spec) override {
|
|
auto &os = Catch::cout();
|
|
os << "[ NO TEST ] no matching test cases for spec: " << spec << '\n';
|
|
os.flush();
|
|
}
|
|
|
|
void reportInvalidArguments(std::string const &arg) override {
|
|
auto &os = Catch::cout();
|
|
os << "[ ERROR ] invalid Catch2 arguments: " << arg << '\n';
|
|
os.flush();
|
|
}
|
|
|
|
void assertionStarting(Catch::AssertionInfo const &) override {}
|
|
|
|
bool assertionEnded(Catch::AssertionStats const &) override { return false; }
|
|
|
|
private:
|
|
void print_python_version_once() {
|
|
if (printed_) {
|
|
return;
|
|
}
|
|
printed_ = true;
|
|
auto &os = Catch::cout();
|
|
os << "[ PYTHON ] " << Py_GetVersion() << '\n';
|
|
os.flush();
|
|
}
|
|
|
|
bool printed_ = false;
|
|
};
|
|
|
|
} // namespace
|
|
|
|
CATCH_REGISTER_REPORTER("progress", ProgressReporter)
|
|
|
|
int main(int argc, char *argv[]) {
|
|
// Setup for TEST_CASE in test_interpreter.cpp, tagging on a large random number:
|
|
std::string updated_pythonpath("pybind11_test_with_catch_PYTHONPATH_2099743835476552");
|
|
const char *preexisting_pythonpath = getenv("PYTHONPATH");
|
|
if (preexisting_pythonpath != nullptr) {
|
|
#if defined(_WIN32)
|
|
updated_pythonpath += ';';
|
|
#else
|
|
updated_pythonpath += ':';
|
|
#endif
|
|
updated_pythonpath += preexisting_pythonpath;
|
|
}
|
|
#if defined(_WIN32)
|
|
_putenv_s("PYTHONPATH", updated_pythonpath.c_str());
|
|
#else
|
|
setenv("PYTHONPATH", updated_pythonpath.c_str(), /*replace=*/1);
|
|
#endif
|
|
|
|
py::scoped_interpreter guard{};
|
|
|
|
auto result = Catch::Session().run(argc, argv);
|
|
|
|
return result < 0xff ? result : 0xff;
|
|
}
|