Skip to content

Commit

Permalink
Test all log levels are cleaned when logging at another level
Browse files Browse the repository at this point in the history
  • Loading branch information
mturnock committed Jul 31, 2024
1 parent c715f4b commit 47192d3
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -729,6 +729,11 @@ if (BUILD_TESTING)

target_link_libraries (cleanup_with_relative_prefix_unittest PRIVATE glog_test)

add_executable (cleanup_all_log_levels_unittest
src/cleanup_all_log_levels_unittest.cc)

target_link_libraries (cleanup_all_log_levels_unittest PRIVATE glog_test)

set (CLEANUP_LOG_DIR ${glog_BINARY_DIR}/cleanup_tests)

add_test (NAME cleanup_init COMMAND
Expand All @@ -755,6 +760,13 @@ if (BUILD_TESTING)
-DTEST_SUBDIR=test_subdir/
-P ${glog_SOURCE_DIR}/cmake/RunCleanerTest3.cmake
WORKING_DIRECTORY ${glog_BINARY_DIR})
add_test (NAME cleanup_all_log_levels COMMAND
${CMAKE_COMMAND}
-DLOGCLEANUP=$<TARGET_FILE:cleanup_all_log_levels_unittest>
-DTEST_DIR=${glog_BINARY_DIR}/
-DTEST_SUBDIR=test_subdir/
-P ${glog_SOURCE_DIR}/cmake/RunCleanerTestAllLogLevels.cmake
WORKING_DIRECTORY ${glog_BINARY_DIR})

# Fixtures setup
set_tests_properties (cleanup_init PROPERTIES FIXTURES_SETUP logcleanuptest)
Expand All @@ -764,6 +776,7 @@ if (BUILD_TESTING)
set_tests_properties (cleanup_immediately PROPERTIES FIXTURES_REQUIRED logcleanuptest)
set_tests_properties (cleanup_with_absolute_prefix PROPERTIES FIXTURES_REQUIRED logcleanuptest)
set_tests_properties (cleanup_with_relative_prefix PROPERTIES FIXTURES_REQUIRED logcleanuptest)
set_tests_properties (cleanup_all_log_levels PROPERTIES FIXTURES_REQUIRED logcleanuptest)

add_executable (striplog0_unittest
src/striplog_unittest.cc
Expand Down
1 change: 1 addition & 0 deletions bazel/glog.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@ def glog_library(with_gflags = 1, **kwargs):
"cleanup_immediately",
"cleanup_with_absolute_prefix",
"cleanup_with_relative_prefix",
"cleanup_all_log_levels",
# "demangle", # Broken
# "logging", # Broken
# "mock-log", # Broken
Expand Down
34 changes: 34 additions & 0 deletions cmake/RunCleanerTestAllLogLevels.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
file (TOUCH test_cleanup_info_20240312-111111.2222.allloglevels)
file (TOUCH test_cleanup_warning_20240312-111111.2222.allloglevels)
file (TOUCH test_cleanup_error_20240312-111111.2222.allloglevels)
file (TOUCH test_cleanup_info_20240312-111111.2222.allloglevels.notalog)
execute_process (COMMAND ${LOGCLEANUP} RESULT_VARIABLE _RESULT)

if (NOT _RESULT EQUAL 0)
message (FATAL_ERROR "Failed to run logcleanup_unittest (error: ${_RESULT})")
endif (NOT _RESULT EQUAL 0)

file (GLOB LOG_FILES ${TEST_DIR}/test_cleanup_*.allloglevels)
list (LENGTH LOG_FILES NUM_LOG_FILES)

if (WIN32)
# On Windows open files cannot be removed and will result in a permission
# denied error while unlinking such file. Therefore, the last file will be
# retained.
set (_expected 1)
else (WIN32)
set (_expected 0)
endif (WIN32)

if (NOT NUM_LOG_FILES EQUAL _expected)
message (SEND_ERROR "Expected ${_expected} log file in log directory but found ${NUM_LOG_FILES}")
endif (NOT NUM_LOG_FILES EQUAL _expected)

file (GLOB NON_LOG_FILES ${TEST_DIR}/test_cleanup_*.notalog)
list (LENGTH NON_LOG_FILES NUM_NON_LOG_FILES)

if (NOT NUM_NON_LOG_FILES EQUAL 1)
message (SEND_ERROR "Expected 1 non-log file in log directory but found ${NUM_NON_LOG_FILES}")
endif (NOT NUM_NON_LOG_FILES EQUAL 1)

file (REMOVE test_cleanup_info_20240312-111111.2222.allloglevels.notalog)
97 changes: 97 additions & 0 deletions src/cleanup_all_log_levels_unittest.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Copyright (c) 2024, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "base/commandlineflags.h"
#include "glog/logging.h"
#include "glog/raw_logging.h"
#include "googletest.h"

#ifdef GLOG_USE_GFLAGS
# include <gflags/gflags.h>
using namespace GFLAGS_NAMESPACE;
#endif

#ifdef HAVE_LIB_GMOCK
# include <gmock/gmock.h>

# include "mock-log.h"
// Introduce several symbols from gmock.
using google::glog_testing::ScopedMockLog;
using testing::_;
using testing::AllOf;
using testing::AnyNumber;
using testing::HasSubstr;
using testing::InitGoogleMock;
using testing::StrictMock;
using testing::StrNe;
#endif

using namespace google;

TEST(CleanImmediatelyAllLogLevels, logging) {
using namespace std::chrono_literals;
google::EnableLogCleaner(0h);
google::SetLogFilenameExtension(".allloglevels");
google::SetLogDestination(GLOG_INFO, "test_cleanup_info_");
google::SetLogDestination(GLOG_WARNING, "test_cleanup_warning_");
google::SetLogDestination(GLOG_ERROR, "test_cleanup_error_");

LOG(INFO) << "cleanup test";

google::DisableLogCleaner();
}

int main(int argc, char** argv) {
FLAGS_colorlogtostderr = false;
FLAGS_timestamp_in_logfile_name = true;
#ifdef GLOG_USE_GFLAGS
ParseCommandLineFlags(&argc, &argv, true);
#endif
// Make sure stderr is not buffered as stderr seems to be buffered
// on recent windows.
setbuf(stderr, nullptr);

// Test some basics before InitGoogleLogging:
CaptureTestStderr();
const string early_stderr = GetCapturedTestStderr();

EXPECT_FALSE(IsGoogleLoggingInitialized());

InitGoogleLogging(argv[0]);

EXPECT_TRUE(IsGoogleLoggingInitialized());

InitGoogleTest(&argc, argv);
#ifdef HAVE_LIB_GMOCK
InitGoogleMock(&argc, argv);
#endif

// so that death tests run before we use threads
CHECK_EQ(RUN_ALL_TESTS(), 0);
}

0 comments on commit 47192d3

Please sign in to comment.