Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an experimental new way of capturing stdout/stderr
Unlike the relatively non-invasive old way of capturing stdout/stderr, this new way is also able to capture output from C's stdlib functions such as `printf`. This is done by redirecting stdout and stderr file descriptors to a file, and then reading this file back. This approach has two sizeable drawbacks: 1) Performance, obviously. Previously an installed capture made the program run faster (as long as it was then discarded), because a call to `std::cout` did not result in text output to the console. This new capture method in fact forces disk IO. While it is likely that any modern OS will keep this file in memory-cache and might never actually issue the IO to the backing storage, it is still a possibility and calls to the file system are not free. 2) Nonportability. While POSIX is usually assumed portable, and this implementation relies only on a very common parts of it, it is no longer standard C++ (or just plain C) and thus might not be available on some obscure platforms. Different C libs might also implement the relevant functions in a less-than-useful ways (e.g. MS's `tmpfile` generates a temp file inside system folder, so it will not work without elevated privileges and thus is useless). These two drawbacks mean that, at least for now, the new capture is opt-in. To opt-in, `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` needs to be defined in the implementation file. Closes #1243
- Loading branch information
Showing
5 changed files
with
243 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * Created by Martin on 28/04/2018. | ||
| * | ||
| * Distributed under the Boost Software License, Version 1.0. (See accompanying | ||
| * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | ||
| */ | ||
|
|
||
| #include "catch_output_redirect.h" | ||
|
|
||
|
|
||
|
|
||
| #include <cstdio> | ||
| #include <cstring> | ||
| #include <fstream> | ||
| #include <sstream> | ||
|
|
||
| #if defined(CATCH_PLATFORM_WINDOWS) | ||
| #include <io.h> //_dup and _dup2 | ||
| #define dup _dup | ||
| #define dup2 _dup2 | ||
| #define fileno _fileno | ||
| #else | ||
| #include <unistd.h> // dup and dup2 | ||
| #endif | ||
|
|
||
| namespace Catch { | ||
|
|
||
| RedirectedStream::RedirectedStream( std::ostream& originalStream, std::ostream& redirectionStream ) | ||
| : m_originalStream( originalStream ), | ||
| m_redirectionStream( redirectionStream ), | ||
| m_prevBuf( m_originalStream.rdbuf() ) | ||
| { | ||
| m_originalStream.rdbuf( m_redirectionStream.rdbuf() ); | ||
| } | ||
|
|
||
| RedirectedStream::~RedirectedStream() { | ||
| m_originalStream.rdbuf( m_prevBuf ); | ||
| } | ||
|
|
||
| RedirectedStdOut::RedirectedStdOut() : m_cout( Catch::cout(), m_rss.get() ) {} | ||
| auto RedirectedStdOut::str() const -> std::string { return m_rss.str(); } | ||
|
|
||
| RedirectedStdErr::RedirectedStdErr() | ||
| : m_cerr( Catch::cerr(), m_rss.get() ), | ||
| m_clog( Catch::clog(), m_rss.get() ) | ||
| {} | ||
| auto RedirectedStdErr::str() const -> std::string { return m_rss.str(); } | ||
|
|
||
|
|
||
|
|
||
| #if defined(CATCH_PLATFORM_WINDOWS) | ||
| TempFile::TempFile() { | ||
| if (tmpnam_s(m_buffer)) { | ||
| throw std::runtime_error("Could not get a temp filename"); | ||
| } | ||
| if (fopen_s(&m_file, m_buffer, "w")) { | ||
| char buffer[100]; | ||
| if (strerror_s(buffer, errno)) { | ||
| throw std::runtime_error("Could not translate errno to string"); | ||
| } | ||
| throw std::runtime_error("Could not open the temp file: " + std::string(m_buffer) + buffer); | ||
| } | ||
| } | ||
| #else | ||
| TempFile::TempFile() { | ||
| m_file = std::tmpfile(); | ||
| if (!m_file) { | ||
| throw std::runtime_error("Could not create a temp file."); | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
|
|
||
| TempFile::~TempFile() { | ||
| // TBD: What to do about errors here? | ||
| std::fclose(m_file); | ||
| // We manually create the file on Windows only, on Linux | ||
| // it will be autodeleted | ||
| #if defined(CATCH_PLATFORM_WINDOWS) | ||
| std::remove(m_buffer); | ||
| #endif | ||
| } | ||
|
|
||
|
|
||
| FILE* TempFile::getFile() { | ||
| return m_file; | ||
| } | ||
|
|
||
| std::string TempFile::getContents() { | ||
| std::stringstream sstr; | ||
| char buffer[100] = {}; | ||
| std::rewind(m_file); | ||
| while (std::fgets(buffer, sizeof(buffer), m_file)) { | ||
| sstr << buffer; | ||
| } | ||
| return sstr.str(); | ||
| } | ||
|
|
||
| OutputRedirect::OutputRedirect(std::string& stdout_dest, std::string& stderr_dest) : | ||
| m_originalStdout(dup(1)), | ||
| m_originalStderr(dup(2)), | ||
| m_stdoutDest(stdout_dest), | ||
| m_stderrDest(stderr_dest) { | ||
| dup2(fileno(m_stdoutFile.getFile()), 1); | ||
| dup2(fileno(m_stderrFile.getFile()), 2); | ||
| } | ||
|
|
||
| OutputRedirect::~OutputRedirect() { | ||
| Catch::cout() << std::flush; | ||
| fflush(stdout); | ||
| // Since we support overriding these streams, we flush cerr | ||
| // even though std::cerr is unbuffered | ||
| Catch::cerr() << std::flush; | ||
| Catch::clog() << std::flush; | ||
| fflush(stderr); | ||
|
|
||
| dup2(m_originalStdout, 1); | ||
| dup2(m_originalStderr, 2); | ||
|
|
||
| m_stdoutDest += m_stdoutFile.getContents(); | ||
| m_stderrDest += m_stderrFile.getContents(); | ||
| } | ||
|
|
||
|
|
||
| } // namespace Catch | ||
|
|
||
| #if defined(CATCH_PLATFORM_WINDOWS) | ||
| #undef dup | ||
| #undef dup2 | ||
| #undef fileno | ||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Created by Martin on 28/04/2018. | ||
| * | ||
| * Distributed under the Boost Software License, Version 1.0. (See accompanying | ||
| * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | ||
| */ | ||
| #ifndef TWOBLUECUBES_CATCH_OUTPUT_REDIRECT_H | ||
| #define TWOBLUECUBES_CATCH_OUTPUT_REDIRECT_H | ||
|
|
||
| #include "catch_platform.h" | ||
| #include "catch_stream.h" | ||
|
|
||
| #include <cstdio> | ||
| #include <iosfwd> | ||
| #include <string> | ||
|
|
||
| namespace Catch { | ||
|
|
||
| class RedirectedStream { | ||
| std::ostream& m_originalStream; | ||
| std::ostream& m_redirectionStream; | ||
| std::streambuf* m_prevBuf; | ||
|
|
||
| public: | ||
| RedirectedStream( std::ostream& originalStream, std::ostream& redirectionStream ); | ||
| ~RedirectedStream(); | ||
| }; | ||
|
|
||
| class RedirectedStdOut { | ||
| ReusableStringStream m_rss; | ||
| RedirectedStream m_cout; | ||
| public: | ||
| RedirectedStdOut(); | ||
| auto str() const -> std::string; | ||
| }; | ||
|
|
||
| // StdErr has two constituent streams in C++, std::cerr and std::clog | ||
| // This means that we need to redirect 2 streams into 1 to keep proper | ||
| // order of writes | ||
| class RedirectedStdErr { | ||
| ReusableStringStream m_rss; | ||
| RedirectedStream m_cerr; | ||
| RedirectedStream m_clog; | ||
| public: | ||
| RedirectedStdErr(); | ||
| auto str() const -> std::string; | ||
| }; | ||
|
|
||
|
|
||
| // Windows's implementation of std::tmpfile is terrible (it tries | ||
| // to create a file inside system folder, thus requiring elevated | ||
| // privileges for the binary), so we have to use tmpnam(_s) and | ||
| // create the file ourselves there. | ||
| class TempFile { | ||
| public: | ||
| TempFile(TempFile const&) = delete; | ||
| TempFile& operator=(TempFile const&) = delete; | ||
| TempFile(TempFile&&) = delete; | ||
| TempFile& operator=(TempFile&&) = delete; | ||
|
|
||
| TempFile(); | ||
| ~TempFile(); | ||
|
|
||
| std::FILE* getFile(); | ||
| std::string getContents(); | ||
|
|
||
| private: | ||
| std::FILE* m_file = nullptr; | ||
| #if defined(CATCH_PLATFORM_WINDOWS) | ||
| char m_buffer[L_tmpnam] = { 0 }; | ||
| #endif | ||
| }; | ||
|
|
||
|
|
||
| class OutputRedirect { | ||
| public: | ||
| OutputRedirect(OutputRedirect const&) = delete; | ||
| OutputRedirect& operator=(OutputRedirect const&) = delete; | ||
| OutputRedirect(OutputRedirect&&) = delete; | ||
| OutputRedirect& operator=(OutputRedirect&&) = delete; | ||
|
|
||
|
|
||
| OutputRedirect(std::string& stdout_dest, std::string& stderr_dest); | ||
| ~OutputRedirect(); | ||
|
|
||
| private: | ||
| int m_originalStdout = -1; | ||
| int m_originalStderr = -1; | ||
| TempFile m_stdoutFile; | ||
| TempFile m_stderrFile; | ||
| std::string& m_stdoutDest; | ||
| std::string& m_stderrDest; | ||
| }; | ||
|
|
||
|
|
||
| } // end namespace Catch | ||
|
|
||
| #endif // TWOBLUECUBES_CATCH_OUTPUT_REDIRECT_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters