iointercept.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <iostream>
#include <framework/utilities/IOIntercept.h>
#include <framework/utilities/testhelpers/Fixtures.h>
#include <gtest/gtest.h>
 
using namespace Belle2;
 
namespace {
  using logconvert_params_t = std::tuple<LogConfig::ELogLevel, std::string, std::string, bool, bool>;

  using IOInterceptTest = TestHelpers::LogMessageTest;

  using IOInterceptDeathTest = IOInterceptTest;

  class IOInterceptParamTest: public IOInterceptTest, public ::testing::WithParamInterface<logconvert_params_t> {};

  TEST_P(IOInterceptParamTest, ConvertToLogMessage)
  {
    // first let's get the parameters
    LogConfig::ELogLevel level;
    std::string raw_message, formatted_message;
    bool useStdout, generateMessage;
    std::tie(level, raw_message, formatted_message, useStdout, generateMessage) = GetParam();
    // now create some output and convert it to log messages
    IOIntercept::OutputToLogMessages capture("capture_name", level, level);
    capture.start();
    (useStdout ? std::cout : std::cerr) << raw_message;
    capture.finish();
    // check that the amount of log messages is correct
    expectMessage(level, generateMessage ? 1 : 0, true);
    if (!generateMessage) return;
    // and also check the message level and content
    expectMessageContent(level, "Output from capture_name:\ncapture_name: " + formatted_message);
  }

  logconvert_params_t logconvert_params[] = {
    // test info message for stdout and stderr
    {LogConfig::c_Info, "foo", "foo", false, true},
    {LogConfig::c_Info, "foo", "foo", true, true},
    // also for error
    {LogConfig::c_Error, "foo", "foo", false, true},
    {LogConfig::c_Error, "foo", "foo", true, true},
    // ok, test the other levels only for stdout
    {LogConfig::c_Warning, "foo", "foo", false, true},
    {LogConfig::c_Result, "foo", "foo", false, true},
    // test that empty message gets removed
    {LogConfig::c_Info, "", "", false, false},
    // also with whitespace
    {LogConfig::c_Info, " ", "", false, false},
    {LogConfig::c_Info, " \t ", "", false, false},
    {LogConfig::c_Info, " \n ", "", false, false},
    // trim space at end
    {LogConfig::c_Info, "message\n\n   \t\r\n", "message", false, true},
    // trim space at beginning
    {LogConfig::c_Info, "   \n\t\nmessage", "message", false, true},
    // but not the spaces in the first line which also contains text to not break alignment of formatted output
    {LogConfig::c_Info, "   \n\tmessage", "\tmessage", false, true},
    {LogConfig::c_Info, "   \n  message", "  message", false, true},
 
  };

  INSTANTIATE_TEST_SUITE_P(Params, IOInterceptParamTest, ::testing::ValuesIn(logconvert_params));

  TEST_F(IOInterceptTest, LogMessagesNoFinish)
  {
    {
      IOIntercept::OutputToLogMessages logmessages("capture_name");
      logmessages.setIndent("-");
      logmessages.start();
      std::cout << "this is my message";
    }
    // check that the amount of log messages is correct
    expectMessage(LogConfig::c_Info, 1, true);
    // and also check the message level and content
    expectMessageContent(LogConfig::c_Info, "Output from capture_name:\n-this is my message");
  }

  TEST_F(IOInterceptTest, InterceptGuard)
  {
    IOIntercept::OutputToLogMessages logmessages("capture_name");
    logmessages.setIndent("-");
    {
      IOIntercept::InterceptorScopeGuard<IOIntercept::OutputToLogMessages> guard{logmessages};
      std::cout << "this is my message";
    }
    std::cout << "this will not be captured" << std::endl;
    {
      // cppcheck-suppress unreadVariable ; cppcheck doesn't realize this has side effects.
      auto guard = IOIntercept::start_intercept(logmessages);
      std::cerr << "this is my error";
    }
    std::cerr << "this will not be captured" << std::endl;
    ASSERT_EQ(m_messages.size(), 2);
    // and also check the message level and content
    expectMessageContent(LogConfig::c_Error, "Output from capture_name:\n-this is my error");
    m_messages.pop_back();
    expectMessageContent(LogConfig::c_Info, "Output from capture_name:\n-this is my message");
  }

  TEST_F(IOInterceptTest, ConvertCheckIndent)
  {
    IOIntercept::OutputToLogMessages capture("indent");
    capture.start();
    std::cout << "this is\na multi line message";
    capture.finish();
    expectMessage(LogConfig::c_Info, 1, true);
    expectMessageContent(LogConfig::c_Info, "Output from indent:\nindent: this is\nindent: a multi line message");
  }

  TEST_F(IOInterceptTest, ConvertSetIndent)
  {
    IOIntercept::OutputToLogMessages capture("indent");
    capture.start();
    std::cout << "this is\na multi line message";
    capture.setIndent("--->");
    capture.finish();
    expectMessage(LogConfig::c_Info, 1, true);
    expectMessageContent(LogConfig::c_Info, "Output from indent:\n--->this is\n--->a multi line message");
  }

  TEST_F(IOInterceptTest, ConvertEmptyIndent)
  {
    IOIntercept::OutputToLogMessages capture("indent");
    capture.start();
    capture.setIndent("");
    std::cout << "this is\na multi line message";
    capture.finish();
    expectMessage(LogConfig::c_Info, 1, true);
    expectMessageContent(LogConfig::c_Info, "Output from indent:\nthis is\na multi line message");
  }

  TEST_F(IOInterceptTest, CaptureStdOut)
  {
    IOIntercept::CaptureStdOut capture;
    ASSERT_FALSE(capture.finish());
    ASSERT_TRUE(capture.start());
    ASSERT_TRUE(capture.start());
    std::cout << "this is a test";
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdOut(), "this is a test");
    ASSERT_FALSE(capture.finish());
    ASSERT_EQ(capture.getStdOut(), "this is a test");
 
    // Ok, again with raw write to fd
    ASSERT_TRUE(capture.start());
    write(fileno(stdout), "this is a test", 14);
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdOut(), "this is a test");
  }

  TEST_F(IOInterceptTest, CaptureStdErr)
  {
    IOIntercept::CaptureStdErr capture;
    ASSERT_FALSE(capture.finish());
    ASSERT_TRUE(capture.start());
    ASSERT_TRUE(capture.start());
    std::cerr << "this is a test";
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdErr(), "this is a test");
    ASSERT_FALSE(capture.finish());
    ASSERT_EQ(capture.getStdErr(), "this is a test");
 
    // Ok, again with raw write to fd
    ASSERT_TRUE(capture.start());
    write(fileno(stderr), "this is a test", 14);
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdErr(), "this is a test");
  }

  TEST_F(IOInterceptTest, CaptureLargeOutput)
  {
    IOIntercept::CaptureStdOut capture;
    ASSERT_TRUE(capture.start());
    std::string out;
    int written{0};
    for (int i = 0; i < 100000; ++i) {
      std::cout << (char)(i % 255) << std::flush;
      if (std::cout.good()) written = i + 1;
      out.push_back(i % 255);
    }
    ASSERT_TRUE(capture.finish());
    const std::string& captured = capture.getStdOut();
    // pipes have a limited capacity. We create them non-blocking which
    // means that once they're full we will just not get any output back.
    // So check that the begin of the capture works
    ASSERT_TRUE(captured.size() <= out.size());
    ASSERT_EQ(captured.size(), written);
    if (captured.size() < out.size()) {
      std::cout << "Output truncated after " << captured.size() << " bytes" << std::endl;
    }
    ASSERT_EQ(captured, out.substr(0, captured.size()));
    // and that capturing still works after overflow
    ASSERT_TRUE(capture.start());
    std::cout << "once more";
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdOut(), "once more");
 
    // and once more for C
    ASSERT_TRUE(capture.start());
    printf("once more");
    ASSERT_TRUE(capture.finish());
    ASSERT_EQ(capture.getStdOut(), "once more");
  }

  void generateStdErr()
  {
    IOIntercept::DiscardStdErr discard;
    std::cerr << "start->";
    discard.start();
    std::cerr << "this should not show up" << std::endl << std::flush;
    write(fileno(stderr), "nor this\n", 9);
    discard.finish();
    std::cerr << "<-end";
    std::exit(0);
  }

  TEST_F(IOInterceptDeathTest, DiscardStdOut)
  {
    IOIntercept::DiscardStdOutStdErr discard;
    ASSERT_FALSE(discard.finish());
    ASSERT_TRUE(discard.start());
    ASSERT_TRUE(discard.start());
    ASSERT_TRUE(discard.finish());
    ASSERT_FALSE(discard.finish());
    // hard to test if there's no output ... let's use a death test and
    // verify that stderr of child process matches what we expect
    EXPECT_EXIT(generateStdErr(), ::testing::ExitedWithCode(0), "^start-><-end$");
  }

  void generateAbort()
  {
    IOIntercept::CaptureStdErr output;
    std::cerr << "start->";
    output.start();
    std::cerr << "now we abort" << std::endl;
    std::abort();
  }

  TEST_F(IOInterceptDeathTest, HandleAbort)
  {
    EXPECT_EXIT(generateAbort(), ::testing::ExitedWithCode(1), "^start->now we abort\nabort\\(\\) called, exiting\n$");
  }
}