(logging-log4cxx) branch master updated: CyclicBuffer validation ordering and resize wraparound handling (#649)

[swebb2066]

This is an automated email from the ASF dual-hosted git repository.

swebb2066 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git


The following commit(s) were added to refs/heads/master by this push:
     new 83eac964 CyclicBuffer validation ordering and resize wraparound 
handling (#649)
83eac964 is described below

commit 83eac964a75bc2940abbb0114aa9636a9c45228d
Author: jmestwa-coder <jmes...@gmail.com>
AuthorDate: Sat May 9 07:13:35 2026 +0530

    CyclicBuffer validation ordering and resize wraparound handling (#649)
---
 src/main/cpp/cyclicbuffer.cpp                 | 27 ++++++++++++++++++---------
 src/test/cpp/helpers/cyclicbuffertestcase.cpp | 25 +++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 9 deletions(-)

diff --git a/src/main/cpp/cyclicbuffer.cpp b/src/main/cpp/cyclicbuffer.cpp
index 2d2a9118..799d4dc6 100644
--- a/src/main/cpp/cyclicbuffer.cpp
+++ b/src/main/cpp/cyclicbuffer.cpp
@@ -25,6 +25,22 @@ using namespace LOG4CXX_NS;
 using namespace LOG4CXX_NS::helpers;
 using namespace LOG4CXX_NS::spi;
 
+namespace
+{
+int validateMaxSize(int maxSize)
+{
+       if (maxSize < 1)
+       {
+               LogString msg(LOG4CXX_STR("The maxSize argument ("));
+               StringHelper::toString(maxSize, msg);
+               msg.append(LOG4CXX_STR(") is not a positive integer."));
+               throw IllegalArgumentException(msg);
+       }
+
+       return maxSize;
+}
+}
+
 struct CyclicBuffer::CyclicBufferPriv
 {
        CyclicBufferPriv(int maxSize1) :
@@ -43,15 +59,8 @@ The <code>maxSize</code> argument must a positive integer.
 @param maxSize The maximum number of elements in the buffer.
 */
 CyclicBuffer::CyclicBuffer(int maxSize1)
-       : m_priv(std::make_unique<CyclicBufferPriv>(maxSize1))
+       : m_priv(std::make_unique<CyclicBufferPriv>(validateMaxSize(maxSize1)))
 {
-       if (maxSize1 < 1)
-       {
-               LogString msg(LOG4CXX_STR("The maxSize argument ("));
-               StringHelper::toString(maxSize1, msg);
-               msg.append(LOG4CXX_STR(") is not a positive integer."));
-               throw IllegalArgumentException(msg);
-       }
 }
 
 CyclicBuffer::~CyclicBuffer()
@@ -153,7 +162,7 @@ void CyclicBuffer::resize(int newSize)
                temp[i] = m_priv->ea[m_priv->first];
                m_priv->ea[m_priv->first] = 0;
 
-               if (++m_priv->first == m_priv->numElems)
+               if (++m_priv->first == m_priv->maxSize)
                {
                        m_priv->first = 0;
                }
diff --git a/src/test/cpp/helpers/cyclicbuffertestcase.cpp 
b/src/test/cpp/helpers/cyclicbuffertestcase.cpp
index 859ff076..7ea7fc83 100644
--- a/src/test/cpp/helpers/cyclicbuffertestcase.cpp
+++ b/src/test/cpp/helpers/cyclicbuffertestcase.cpp
@@ -16,6 +16,7 @@
  */
 
 #include <log4cxx/helpers/cyclicbuffer.h>
+#include <log4cxx/helpers/exception.h>
 #include "../logunit.h"
 
 #include <log4cxx/logmanager.h>
@@ -36,6 +37,8 @@ LOGUNIT_CLASS(CyclicBufferTestCase)
        LOGUNIT_TEST(test0);
        LOGUNIT_TEST(test1);
        LOGUNIT_TEST(testResize);
+       LOGUNIT_TEST_EXCEPTION(testNegativeSizeRejectedBeforeAllocation, 
IllegalArgumentException);
+       LOGUNIT_TEST(testResizeAfterReadPreservesOrder);
        LOGUNIT_TEST_SUITE_END();
 
        LoggerPtr logger;
@@ -167,6 +170,28 @@ public:
                        LOGUNIT_ASSERT_EQUAL(e[offset + j], cb.get(j));
                }
        }
+
+       void testNegativeSizeRejectedBeforeAllocation()
+       {
+               CyclicBuffer cb(-1);
+       }
+
+       void testResizeAfterReadPreservesOrder()
+       {
+               CyclicBuffer cb(5);
+               cb.add(e[0]);
+               cb.add(e[1]);
+               cb.add(e[2]); // first=0, numElems=3
+
+               LOGUNIT_ASSERT_EQUAL(e[0], cb.get()); // first=1, numElems=2
+
+               cb.resize(4);
+
+               LOGUNIT_ASSERT_EQUAL(2, cb.length());
+               LOGUNIT_ASSERT_EQUAL(e[1], cb.get());
+               LOGUNIT_ASSERT_EQUAL(e[2], cb.get());
+               LOGUNIT_ASSERT(cb.get() == 0);
+       }
 };
 
 LOGUNIT_TEST_SUITE_REGISTRATION(CyclicBufferTestCase);