Skip to content

Commit

Permalink
Don't send full stdout so far to testCasePartialEnded event
Browse files Browse the repository at this point in the history
  • Loading branch information
horenmar committed Jan 1, 2022
1 parent c9c3b74 commit 6b55f5d
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/catch2/internal/catch_run_context.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ namespace Catch {
redirectedCerr += oneRunCerr;

const auto singleRunTotals = m_totals.delta(beforeRunTotals);
auto statsForOneRun = TestCaseStats(testInfo, singleRunTotals, redirectedCout, oneRunCerr, aborting());
auto statsForOneRun = TestCaseStats(testInfo, singleRunTotals, oneRunCout, oneRunCerr, aborting());

m_reporter->testCasePartialEnded(statsForOneRun, testRuns);
++testRuns;
Expand Down
14 changes: 14 additions & 0 deletions tests/ExtraTests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,20 @@ set_tests_properties(
PASS_REGULAR_EXPRESSION "TestReporter constructed"
)

add_executable(CapturedStdoutInTestCaseEvents ${TESTS_DIR}/X27-CapturedStdoutInTestCaseEvents.cpp)
target_link_libraries(CapturedStdoutInTestCaseEvents PRIVATE Catch2::Catch2WithMain)
add_test(
NAME Reporters::CapturedStdOutInEvents
COMMAND CapturedStdoutInTestCaseEvents
--reporter test-reporter
)
set_tests_properties(
Reporters::CapturedStdOutInEvents
PROPERTIES
PASS_REGULAR_EXPRESSION "X27 - TestReporter constructed"
FAIL_REGULAR_EXPRESSION "X27 ERROR"
)


add_executable(DuplicatedTestCases-SameNameAndTags ${TESTS_DIR}/X31-DuplicatedTestCases.cpp)
target_link_libraries(DuplicatedTestCases-SameNameAndTags PRIVATE Catch2::Catch2WithMain)
Expand Down
81 changes: 81 additions & 0 deletions tests/ExtraTests/X27-CapturedStdoutInTestCaseEvents.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@

// Copyright Catch2 Authors
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// https://www.boost.org/LICENSE_1_0.txt)

// SPDX-License-Identifier: BSL-1.0

/**\file
* Test that the captured stdout/err in (partial) testCaseEnded events
* is correct (e.g. that the partial test case event does not get accumulated
* output).
*
* This is done by having a single test case that is entered multiple
* times through generator, and a custom capturing reporter that knows
* what it should expect captured from the test case.
*/


#include <catch2/catch_test_macros.hpp>
#include <catch2/generators/catch_generators.hpp>
#include <catch2/generators/catch_generators_range.hpp>
#include <catch2/reporters/catch_reporter_streaming_base.hpp>
#include <catch2/reporters/catch_reporter_registrars.hpp>


#include <iostream>
#include <string>

class TestReporter : public Catch::StreamingReporterBase {
std::string stdOutString( uint64_t iter ){
return "stdout " + std::to_string( iter ) + '\n';
}
std::string stdErrString(uint64_t iter) {
return "stderr " + std::to_string( iter ) + '\n';
}

public:
TestReporter( Catch::ReporterConfig const& _config ):
StreamingReporterBase( _config ) {
m_preferences.shouldRedirectStdOut = true;
std::cout << "X27 - TestReporter constructed\n";
}

static std::string getDescription() {
return "X27 test reporter";
}

void testCasePartialEnded( Catch::TestCaseStats const& stats,
uint64_t iter ) override {
if ( stats.stdOut != stdOutString( iter ) ) {
std::cerr << "X27 ERROR in partial stdout\n" << stats.stdOut;
}
if ( stats.stdErr != stdErrString( iter ) ) {
std::cerr << "X27 ERROR in partial stderr\n" << stats.stdErr;
}
}

void testCaseEnded( Catch::TestCaseStats const& stats ) override {
if ( stats.stdOut != "stdout 0\nstdout 1\nstdout 2\nstdout 3\nstdout 4\nstdout 5\n" ) {
std::cerr << "X27 ERROR in full stdout\n" << stats.stdOut;
}
if ( stats.stdErr != "stderr 0\nstderr 1\nstderr 2\nstderr 3\nstderr 4\nstderr 5\n" ) {
std::cerr << "X27 ERROR in full stderr\n" << stats.stdErr;
}
}

~TestReporter() override;
};

TestReporter::~TestReporter() = default;

CATCH_REGISTER_REPORTER( "test-reporter", TestReporter )

TEST_CASE( "repeatedly entered test case" ) {
auto i = GENERATE( range(0, 6) );
std::cout << "stdout " << i << '\n';
// Switch between writing to std::cerr and std::clog just to make sure
// both are properly captured and redirected.
( ( i % 2 == 0 ) ? std::cerr : std::clog ) << "stderr " << i << '\n';
}

0 comments on commit 6b55f5d

Please sign in to comment.