AspectCommandDebugger: small refactoring + unit tests

Change-Id: I0a6fd4dfc5a1274ec842513f1e43931c442c5eb5
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

5 files changed, 146 insertions, 23 deletions

diff --git a/src/core/aspects/aspectcommanddebugger.cpp b/src/core/aspects/aspectcommanddebugger.cpp
index e38ffc844..a12a904d7 100644
--- a/src/core/aspects/aspectcommanddebugger.cpp
+++ b/src/core/aspects/aspectcommanddebugger.cpp
@@ -65,12 +65,29 @@ struct CommandHeader
 } // anonymous
 
 AspectCommandDebugger::ReadBuffer::ReadBuffer()
-    : buffer(4096, 0)
+    : buffer()
     , startIdx(0)
     , endIdx(0)
 {
 }
 
+void AspectCommandDebugger::ReadBuffer::insert(const QByteArray &array)
+{
+    buffer.insert(endIdx, array);
+    endIdx += array.size();
+}
+
+void AspectCommandDebugger::ReadBuffer::trim()
+{
+    if (startIdx != endIdx && startIdx != 0) {
+        memcpy(buffer.data(),
+               buffer.constData() + startIdx,
+               size());
+        endIdx -= startIdx;
+        startIdx = 0;
+    }
+}
+
 AspectCommandDebugger::AspectCommandDebugger(QObject *parent)
     : QTcpServer(parent)
     , m_aspectEngine(nullptr)
@@ -122,14 +139,13 @@ void AspectCommandDebugger::asynchronousReplyFinished(AsynchronousCommandReply *
 void AspectCommandDebugger::onCommandReceived(QTcpSocket *socket)
 {
     const QByteArray newData = socket->readAll();
-    m_readBuffer.buffer.insert(m_readBuffer.endIdx, newData);
-    m_readBuffer.endIdx += newData.size();
+    m_readBuffer.insert(newData);
 
     const int commandPacketSize = sizeof(CommandHeader);
-    while ((m_readBuffer.endIdx - m_readBuffer.startIdx) >= commandPacketSize) {
+    while (m_readBuffer.size() >= commandPacketSize) {
         CommandHeader *header = reinterpret_cast<CommandHeader *>(m_readBuffer.buffer.data() + m_readBuffer.startIdx);
         if (header->magic == MagicNumber &&
-                (m_readBuffer.endIdx - (m_readBuffer.startIdx + commandPacketSize)) >= header->size) {
+                (m_readBuffer.size() - commandPacketSize) >= header->size) {
             // We have a valid command
             // We expect command to be a CommandHeader + some json text
             const QJsonDocument doc = QJsonDocument::fromJson(
@@ -147,15 +163,9 @@ void AspectCommandDebugger::onCommandReceived(QTcpSocket *socket)
             m_readBuffer.startIdx += commandPacketSize + header->size;
         }
     }
-    if (m_readBuffer.startIdx != m_readBuffer.endIdx && m_readBuffer.startIdx != 0) {
-        // Copy remaining length of buffer at begininning
-        memcpy(m_readBuffer.buffer.data(),
-               m_readBuffer.buffer.constData() + m_readBuffer.startIdx,
-               m_readBuffer.endIdx - m_readBuffer.startIdx);
-    }
-    m_readBuffer.endIdx -= m_readBuffer.startIdx;
-    m_readBuffer.startIdx = 0;
-
+    // Copy remaining length of buffer at begininning if we have read some commands
+    // and some partial one remain
+    m_readBuffer.trim();
 }
 
 void AspectCommandDebugger::sendReply(QTcpSocket *socket, const QByteArray &payload)
diff --git a/src/core/aspects/aspectcommanddebugger_p.h b/src/core/aspects/aspectcommanddebugger_p.h
index 917019b6d..b173a5c09 100644
--- a/src/core/aspects/aspectcommanddebugger_p.h
+++ b/src/core/aspects/aspectcommanddebugger_p.h
@@ -65,7 +65,7 @@ namespace Debug {
 
 class AsynchronousCommandReply;
 
-class AspectCommandDebugger : public QTcpServer
+class Q_AUTOTEST_EXPORT AspectCommandDebugger : public QTcpServer
 {
     Q_OBJECT
 public:
@@ -74,6 +74,18 @@ public:
     void initialize();
     void setAspectEngine(QAspectEngine *engine);
 
+    struct ReadBuffer {
+        ReadBuffer();
+
+        QByteArray buffer;
+        int startIdx;
+        int endIdx;
+
+        inline int size() const { return endIdx - startIdx; }
+        void insert(const QByteArray &array);
+        void trim();
+    };
+
 private Q_SLOTS:
     void asynchronousReplyFinished(AsynchronousCommandReply *reply);
 
@@ -85,13 +97,6 @@ private:
     QVector<QTcpSocket *> m_connections;
     QAspectEngine *m_aspectEngine;
 
-    struct ReadBuffer {
-        ReadBuffer();
-
-        QByteArray buffer;
-        int startIdx;
-        int endIdx;
-    };
     ReadBuffer m_readBuffer;
     QHash<AsynchronousCommandReply *, QTcpSocket *> m_asyncCommandToSocketEntries;
 };
diff --git a/tests/auto/core/aspectcommanddebugger/aspectcommanddebugger.pro b/tests/auto/core/aspectcommanddebugger/aspectcommanddebugger.pro
new file mode 100644
index 000000000..029a84507
--- /dev/null
+++ b/tests/auto/core/aspectcommanddebugger/aspectcommanddebugger.pro
@@ -0,0 +1,7 @@
+TARGET = tst_aspectcommandddebugger
+CONFIG += testcase
+TEMPLATE = app
+
+SOURCES += tst_aspectcommanddebugger.cpp
+
+QT += testlib 3dcore 3dcore-private core-private
diff --git a/tests/auto/core/aspectcommanddebugger/tst_aspectcommanddebugger.cpp b/tests/auto/core/aspectcommanddebugger/tst_aspectcommanddebugger.cpp
new file mode 100644
index 000000000..1bcaced2c
--- /dev/null
+++ b/tests/auto/core/aspectcommanddebugger/tst_aspectcommanddebugger.cpp
@@ -0,0 +1,100 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QTest>
+#include <Qt3DCore/private/aspectcommanddebugger_p.h>
+
+#ifdef QT3D_JOBS_RUN_STATS
+using namespace Qt3DCore::Debug;
+#endif
+
+class tst_AspectCommandDebugger : public QObject
+{
+    Q_OBJECT
+
+private slots:
+#ifdef QT3D_JOBS_RUN_STATS
+    void checkReadBufferInitialState()
+    {
+        // GIVEN
+        AspectCommandDebugger::ReadBuffer buffer;
+
+        // THEN
+        QCOMPARE(buffer.startIdx, 0);
+        QCOMPARE(buffer.endIdx, 0);
+    }
+
+    void checkReadBufferInsert()
+    {
+        // GIVEN
+        AspectCommandDebugger::ReadBuffer buffer;
+
+        // WHEN
+        QByteArray fakeData(1024, '8');
+        buffer.insert(fakeData);
+
+        // THEN
+        QCOMPARE(buffer.startIdx, 0);
+        QCOMPARE(buffer.endIdx, 1024);
+        QCOMPARE(buffer.buffer.size(), 1024);
+        QCOMPARE(fakeData, QByteArray(buffer.buffer.constData(), 1024));
+
+        // WHEN
+        QByteArray hugeFakeData(1024 * 16, '.');
+        buffer.insert(hugeFakeData);
+
+        // THEN
+        QCOMPARE(buffer.startIdx, 0);
+        QCOMPARE(buffer.endIdx, 1024 + 16 * 1024);
+        QCOMPARE(fakeData, QByteArray(buffer.buffer.constData(), 1024));
+        QCOMPARE(hugeFakeData, QByteArray(buffer.buffer.constData() + 1024, 1024 * 16));
+    }
+
+    void checkBufferTrim()
+    {
+        // GIVEN
+        AspectCommandDebugger::ReadBuffer buffer;
+        QByteArray fakeData(1024, '9');
+        QByteArray hugeFakeData(1024 * 16, '.');
+        buffer.insert(fakeData);
+        buffer.insert(hugeFakeData);
+
+        // WHEN
+        buffer.startIdx += 1024;
+        buffer.trim();
+
+        // THEN
+        QCOMPARE(buffer.size(), 16 * 1024);
+        QCOMPARE(hugeFakeData, QByteArray(buffer.buffer.constData(), 1024 * 16));
+    }
+#endif
+};
+
+QTEST_APPLESS_MAIN(tst_AspectCommandDebugger)
+
+#include "tst_aspectcommanddebugger.moc"
diff --git a/tests/auto/core/core.pro b/tests/auto/core/core.pro
index 317bef16e..d8c4395a9 100644
--- a/tests/auto/core/core.pro
+++ b/tests/auto/core/core.pro
@@ -19,5 +19,6 @@ contains(QT_CONFIG, private_tests) {
     qentity \
     qframeallocator \
     qtransform \
-    threadpooler
+    threadpooler \
+    aspectcommanddebugger
 }