diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index d93ca4e282..61f8af3f12 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -41,6 +41,7 @@ to use Open Cascade's file I/O capabilities in support of Quest applications. - Adds a piecewise method to load external data using `sidre::IOManager`. This adds new overloaded methods of `loadExternalData` in `sidre::IOManager` and `sidre::Group`. - Adds intersection routines between `primal::Ray` objects and `primal::NURBSCurve`/`primal::NURBSPatch` objects. +- Adds LineFileTagCombiner to Lumberjack to allow combining messages if line number, file, and tag are equal. ### Changed - `primal::NumericArray` has been moved to `core`. The header is `core/NumericArray.hpp`. diff --git a/src/axom/lumberjack/LineFileTagCombiner.hpp b/src/axom/lumberjack/LineFileTagCombiner.hpp new file mode 100644 index 0000000000..26136a842e --- /dev/null +++ b/src/axom/lumberjack/LineFileTagCombiner.hpp @@ -0,0 +1,100 @@ +// Copyright (c) 2017-2025, Lawrence Livermore National Security, LLC and +// other Axom Project Developers. See the top-level LICENSE file for details. +// +// SPDX-License-Identifier: (BSD-3-Clause) + +/*! + ******************************************************************************* + * \file LineFileTagCombiner.hpp + * + * \brief This file contains the class implementation of the + * LineFileTagCombiner. + ******************************************************************************* + */ + +#ifndef LINEFILETAGCOMBINER_HPP +#define LINEFILETAGCOMBINER_HPP + +#include "axom/lumberjack/Combiner.hpp" +#include "axom/lumberjack/Message.hpp" + +#include + +namespace axom +{ +namespace lumberjack +{ +/*! + ******************************************************************************* + * \class LineFileTagCombiner + * + * \brief Combines Message classes if their Message::fileName, + * Message::lineNumer, and Message::tag are equal. + * + ******************************************************************************* + */ +class LineFileTagCombiner : public axom::lumberjack::Combiner +{ +public: + LineFileTagCombiner() { } + + /*! + ***************************************************************************** + * \brief Returns the unique string identifier for this combiner. Used by + * Lumberjack to differentiate between other combiners. + ***************************************************************************** + */ + const std::string id() { return m_id; } + + /*! + ***************************************************************************** + * \brief Function used by Lumberjack to indicate whether two messages should + * be combined. + * + * They are not actually combined by this function. Message classes are + * triggered for combination if Message::fileName, Message::lineNumer, + * and Message::tag are equal. + * + * \param [in] leftMessage One of the Messages to be compared. + * \param [in] rightMessage One of the Messages to be compared. + ***************************************************************************** + */ + bool shouldMessagesBeCombined(const axom::lumberjack::Message& leftMessage, + const axom::lumberjack::Message& rightMessage) + { + return ((leftMessage.lineNumber() == rightMessage.lineNumber()) && + leftMessage.fileName().compare(rightMessage.fileName()) == 0 && + leftMessage.tag().compare(rightMessage.tag()) == 0); + } + + /*! + ***************************************************************************** + * \brief Combines the combinee into the combined Message. + * + * The only thing truly combined in this Combiner is the ranks from combinee + * to combined. The text will not be combined, even if it is not equal. + * Only text from the first message will be saved. + * + * \param [in,out] combined the Message that will be modified. + * \param [in] combinee the Message that is combined into the other. + * \param [in] ranksLimit The limit on how many individual ranks are tracked + * in the combined Message. Message::rankCount is always incremented. + * + * \pre shouldMessagesBeCombined(combined, combinee) must be true + ***************************************************************************** + */ + void combine(axom::lumberjack::Message& combined, + const axom::lumberjack::Message& combinee, + const int ranksLimit) + { + combined.addRanks(combinee.ranks(), combinee.count(), ranksLimit); + } + +private: + const std::string m_id = "LineFileTagCombiner"; +}; + +} // end namespace lumberjack +} // end namespace axom + +#endif \ No newline at end of file diff --git a/src/axom/lumberjack/docs/sphinx/combiner_class.rst b/src/axom/lumberjack/docs/sphinx/combiner_class.rst index 70dcc954d6..9afc83e0be 100644 --- a/src/axom/lumberjack/docs/sphinx/combiner_class.rst +++ b/src/axom/lumberjack/docs/sphinx/combiner_class.rst @@ -46,3 +46,15 @@ the ranksLimit) and incrementing the Message's count as well. This is handled b Message.addRanks(). .. note:: You can add this Combiner by calling Lumberjack::addCombiner(new TextEqualityCombiner). + +.. _linefiletagcombiner_class_label: + +LineFileTagCombiner +^^^^^^^^^^^^^^^^^^^ + +This Combiner combines the two given Messages if the Message line number, file name, +and tag are equal. It does so by adding the second Message's ranks to the first +Message (if not past the ranksLimit) and incrementing the Message's count as well. +This is handled by Message.addRanks(). + +.. note:: You can add this Combiner by calling Lumberjack::addCombiner(new LineFileTagCombiner). The combiner does not compare the text of the two messages passed in. Therefore, the message texts do not get combined, and the first message text remains unchanged. diff --git a/src/axom/lumberjack/tests/CMakeLists.txt b/src/axom/lumberjack/tests/CMakeLists.txt index 2340b6b763..b3ca11f433 100644 --- a/src/axom/lumberjack/tests/CMakeLists.txt +++ b/src/axom/lumberjack/tests/CMakeLists.txt @@ -13,7 +13,8 @@ set(lumberjack_serial_tests lumberjack_Lumberjack.hpp lumberjack_Message.hpp lumberjack_TextEqualityCombiner.hpp - lumberjack_TextTagCombiner.hpp ) + lumberjack_TextTagCombiner.hpp + lumberjack_LineFileTagCombiner.hpp ) axom_add_executable(NAME lumberjack_serial_tests SOURCES lumberjack_serial_main.cpp diff --git a/src/axom/lumberjack/tests/lumberjack_LineFileTagCombiner.hpp b/src/axom/lumberjack/tests/lumberjack_LineFileTagCombiner.hpp new file mode 100644 index 0000000000..382c4feb5f --- /dev/null +++ b/src/axom/lumberjack/tests/lumberjack_LineFileTagCombiner.hpp @@ -0,0 +1,161 @@ +#include +#include +#include +#include "axom/lumberjack/Message.hpp" +#include "axom/lumberjack/LineFileTagCombiner.hpp" + +// Helper function to create a Message +inline axom::lumberjack::Message createMessage(const std::string& text, + int rank, + int rankCount, + const std::string& fileName, + int lineNumber, + const std::string& tag) +{ + axom::lumberjack::Message message; + message.text(text); + message.addRank(rank, rankCount); + message.fileName(fileName); + message.lineNumber(lineNumber); + message.tag(tag); + return message; +} + +// Helper function to verify Message attributes +inline void verifyMessage(const axom::lumberjack::Message& message, + const std::string& expectedText, + int expectedLineNumber, + const std::string& expectedFileName, + int expectedCount, + const std::vector& expectedRanks, + const std::string& expectedTag) +{ + EXPECT_EQ(message.text().compare(expectedText), 0); + EXPECT_EQ(message.lineNumber(), expectedLineNumber); + EXPECT_EQ(message.fileName().compare(expectedFileName), 0); + EXPECT_EQ(message.count(), expectedCount); + EXPECT_EQ(message.ranks().size(), expectedRanks.size()); + for(size_t i = 0; i < expectedRanks.size(); ++i) + { + EXPECT_EQ(message.ranks()[i], expectedRanks[i]); + } + EXPECT_EQ(message.tag().compare(expectedTag), 0); +} + +// Struct to hold test parameters +struct TestParams +{ + std::string caseName {""}; + int lineNumber1 {-1}; + int lineNumber2 {-1}; + std::string fileName1 {""}; + std::string fileName2 {""}; + std::string tag1 {""}; + std::string tag2 {""}; + bool shouldCombine {false}; +}; + +// Parameterized Test Fixture +class LumberjackLineFileTagCombinerTest + : public ::testing::TestWithParam +{ }; + +TEST_P(LumberjackLineFileTagCombinerTest, CombineMessages) +{ + // Arrange + TestParams params = GetParam(); + std::string text1 = + "This message does not matter because we do not filter by text"; + std::string text2 = + "This message ALSO does not matter because we do not filter by text"; + + axom::lumberjack::Message m1 = + createMessage(text1, 13, 5, params.fileName1, params.lineNumber1, params.tag1); + axom::lumberjack::Message m2 = + createMessage(text2, 14, 5, params.fileName2, params.lineNumber2, params.tag2); + + axom::lumberjack::LineFileTagCombiner combiner; + + // Act + bool shouldMessagesBeCombined = combiner.shouldMessagesBeCombined(m1, m2); + if(shouldMessagesBeCombined) + { + combiner.combine(m1, m2, 5); + } + + // Assert + EXPECT_EQ(shouldMessagesBeCombined, params.shouldCombine); + if(params.shouldCombine) + { + verifyMessage(m1, + text1, + params.lineNumber1, + params.fileName1, + 2, + {13, 14}, + params.tag1); + verifyMessage(m2, + text2, + params.lineNumber2, + params.fileName2, + 1, + {14}, + params.tag2); + } + else + { + verifyMessage(m1, + text1, + params.lineNumber1, + params.fileName1, + 1, + {13}, + params.tag1); + verifyMessage(m2, + text2, + params.lineNumber2, + params.fileName2, + 1, + {14}, + params.tag2); + } +} + +// Custom Name Generator for Parameterized Tests +inline std::string CustomNameGenerator( + const ::testing::TestParamInfo& info) +{ + const TestParams& params = info.param; + return params.caseName; +} + +// Define test cases +INSTANTIATE_TEST_SUITE_P( + LumberjackTests, + LumberjackLineFileTagCombinerTest, + ::testing::Values( + // Positive case: Equal line numbers, filenames, and tags + TestParams {"case1", 154, 154, "foo.cpp", "foo.cpp", "myTag", "myTag", true}, + + // Negative case: Different line numbers, same filenames, same tags + TestParams {"case2", 12000, 154, "foo.cpp", "foo.cpp", "myTag", "myTag", false}, + + // Negative case: Same line numbers, different filenames, same tags + TestParams {"case3", 154, 154, "foo.cpp", "bar.cpp", "myTag", "myTag", false}, + + // Negative case: Same line numbers, same filenames, different tags + TestParams {"case4", 154, 154, "foo.cpp", "foo.cpp", "myTag", "myOtherTag", false}, + + // Negative case: Different line numbers, different filenames, same tags + TestParams {"case5", 12000, 154, "foo.cpp", "bar.cpp", "myTag", "myTag", false}, + + // Negative case: Different line numbers, same filenames, different tags + TestParams {"case6", 12000, 154, "foo.cpp", "foo.cpp", "myTag", "myOtherTag", false}, + + // Negative case: Same line numbers, different filenames, different tags + TestParams {"case7", 154, 154, "foo.cpp", "bar.cpp", "myTag", "myOtherTag", false}, + + // Negative case: Different line numbers, different filenames, different tags + TestParams {"case8", 12000, 154, "foo.cpp", "bar.cpp", "myTag", "myOtherTag", false}), + CustomNameGenerator // Use the custom name generator +); \ No newline at end of file diff --git a/src/axom/lumberjack/tests/lumberjack_serial_main.cpp b/src/axom/lumberjack/tests/lumberjack_serial_main.cpp index fc22899094..1cdabe13a4 100644 --- a/src/axom/lumberjack/tests/lumberjack_serial_main.cpp +++ b/src/axom/lumberjack/tests/lumberjack_serial_main.cpp @@ -9,6 +9,7 @@ #include "lumberjack_Message.hpp" #include "lumberjack_TextEqualityCombiner.hpp" #include "lumberjack_TextTagCombiner.hpp" +#include "lumberjack_LineFileTagCombiner.hpp" int main(int argc, char** argv) {