From 9b4df1cea7c2d3b56cc2180915b1c48c1b5aac5b Mon Sep 17 00:00:00 2001 From: Marco Wang Date: Tue, 7 Dec 2021 13:51:05 +0800 Subject: [PATCH] add a new test for log cleaner with relative prefix Signed-off-by: Marco Wang --- CMakeLists.txt | 13 +++ cmake/RunCleanerTest3.cmake | 28 ++++++ src/cleanup_with_relative_prefix_unittest.cc | 97 ++++++++++++++++++++ 3 files changed, 138 insertions(+) create mode 100644 cmake/RunCleanerTest3.cmake create mode 100644 src/cleanup_with_relative_prefix_unittest.cc diff --git a/CMakeLists.txt b/CMakeLists.txt index e355184a2..4ecf463e9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -937,6 +937,11 @@ if (BUILD_TESTING) target_link_libraries (cleanup_with_prefix_unittest PRIVATE ${_GLOG_TEST_LIBS}) + add_executable (cleanup_with_relative_prefix_unittest + src/cleanup_with_relative_prefix_unittest.cc) + + target_link_libraries (cleanup_with_relative_prefix_unittest PRIVATE ${_GLOG_TEST_LIBS}) + set (CLEANUP_LOG_DIR ${CMAKE_CURRENT_BINARY_DIR}/cleanup_tests) add_test (NAME cleanup_init COMMAND @@ -956,6 +961,13 @@ if (BUILD_TESTING) -DTEST_DIR=${CMAKE_CURRENT_BINARY_DIR}/ -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/RunCleanerTest2.cmake WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) + add_test (NAME cleanup_with_relative_prefix COMMAND + ${CMAKE_COMMAND} + -DLOGCLEANUP=$ + -DTEST_DIR=${CMAKE_CURRENT_BINARY_DIR}/ + -DTEST_SUBDIR=test_subdir/ + -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/RunCleanerTest3.cmake + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) # Fixtures setup set_tests_properties (cleanup_init PROPERTIES FIXTURES_SETUP logcleanuptest) @@ -964,6 +976,7 @@ if (BUILD_TESTING) # Fixture requirements set_tests_properties (cleanup_immediately PROPERTIES FIXTURES_REQUIRED logcleanuptest) set_tests_properties (cleanup_with_prefix PROPERTIES FIXTURES_REQUIRED logcleanuptest) + set_tests_properties (cleanup_with_relative_prefix PROPERTIES FIXTURES_REQUIRED logcleanuptest) endif (BUILD_TESTING) install (TARGETS glog diff --git a/cmake/RunCleanerTest3.cmake b/cmake/RunCleanerTest3.cmake new file mode 100644 index 000000000..e8105d111 --- /dev/null +++ b/cmake/RunCleanerTest3.cmake @@ -0,0 +1,28 @@ +set (RUNS 3) + +# Create the subdirectory required by this unit test. +file (MAKE_DIRECTORY ${TEST_DIR}/${TEST_SUBDIR}) + +foreach (iter RANGE 1 ${RUNS}) + execute_process (COMMAND ${LOGCLEANUP} -log_dir=${TEST_DIR} + RESULT_VARIABLE _RESULT) + + if (NOT _RESULT EQUAL 0) + message (FATAL_ERROR "Failed to run logcleanup_unittest (error: ${_RESULT})") + endif (NOT _RESULT EQUAL 0) + + # Ensure the log files to have different modification timestamps such that + # exactly one log file remains at the end. Otherwise all log files will be + # retained. + execute_process (COMMAND ${CMAKE_COMMAND} -E sleep 2) +endforeach (iter) + +file (GLOB LOG_FILES ${TEST_DIR}/${TEST_SUBDIR}/test_cleanup_*.relativefoo) +list (LENGTH LOG_FILES NUM_FILES) + +if (NOT NUM_FILES EQUAL 1) + message (SEND_ERROR "Expected 1 log file in build directory ${TEST_DIR}${TEST_SUBDIR} but found ${NUM_FILES}") +endif (NOT NUM_FILES EQUAL 1) + +# Remove the subdirectory required by this unit test. +file (REMOVE_RECURSE ${TEST_DIR}/${TEST_SUBDIR}) diff --git a/src/cleanup_with_relative_prefix_unittest.cc b/src/cleanup_with_relative_prefix_unittest.cc new file mode 100644 index 000000000..330f4650c --- /dev/null +++ b/src/cleanup_with_relative_prefix_unittest.cc @@ -0,0 +1,97 @@ +// Copyright (c) 2021, 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 +#include + +#include "base/commandlineflags.h" +#include "googletest.h" + +#ifdef HAVE_LIB_GFLAGS +#include +using namespace GFLAGS_NAMESPACE; +#endif + +#ifdef HAVE_LIB_GMOCK +#include + +#include "mock-log.h" +// Introduce several symbols from gmock. +using GOOGLE_NAMESPACE::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_NAMESPACE; + +TEST(CleanImmediatelyWithRelativePrefix, logging) { + google::EnableLogCleaner(0); + google::SetLogFilenameExtension(".relativefoo"); + google::SetLogDestination(GLOG_INFO, "test_subdir/test_cleanup_"); + + for (unsigned i = 0; i < 1000; ++i) { + LOG(INFO) << "cleanup test"; + } + + google::DisableLogCleaner(); +} + +int main(int argc, char **argv) { + FLAGS_colorlogtostderr = false; + FLAGS_timestamp_in_logfile_name = true; +#ifdef HAVE_LIB_GFLAGS + ParseCommandLineFlags(&argc, &argv, true); +#endif + // Make sure stderr is not buffered as stderr seems to be buffered + // on recent windows. + setbuf(stderr, NULL); + + // 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); +}