Merge pull request #40 from scratchcpp/unit_tests

Add unit tests

Author: adazem009

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y nlohmann-json3-dev libutfcpp-dev libgd-dev
+        sudo apt-get install -y nlohmann-json3-dev libutfcpp-dev libgd-dev xvfb libxcb-cursor0
       shell: bash
     - name: Install Qt
       uses: jurplel/install-qt-action@v3
@@ -31,5 +31,5 @@ jobs:
       run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
 
     - name: Build
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j$(nproc --all)
+      run: xvfb-run cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j$(nproc --all)
 

.github/workflows/utests.yml

@@ -0,0 +1,38 @@
+name: Unit tests
+
+on:
+  push:
+    branches: '*'
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  BUILD_TYPE: Debug
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y nlohmann-json3-dev libutfcpp-dev libgd-dev xvfb libxcb-cursor0
+      shell: bash
+    - name: Install Qt
+      uses: jurplel/install-qt-action@v3
+      with:
+        version: '6.6.*'
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DSCRATCHCPPGUI_BUILD_UNIT_TESTS=ON
+
+    - name: Build
+      run: xvfb-run cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j$(nproc --all)
+
+    - name: Run unit tests
+      run: xvfb-run ctest --test-dir build -V
+

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "libscratchcpp"]
 	path = libscratchcpp
 	url = https://github.com/scratchcpp/libscratchcpp
+[submodule "thirdparty/googletest"]
+	path = thirdparty/googletest
+	url = https://github.com/google/googletest

CMakeLists.txt

@@ -9,6 +9,8 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+option(SCRATCHCPPGUI_BUILD_UNIT_TESTS "Build unit tests" ON)
+
 include(build/FindQt.cmake)
 
 qt_standard_project_setup(REQUIRES 6.6)
@@ -18,11 +20,16 @@ set(QML_IMPORT_PATH "${QML_IMPORT_PATH};${PROJECT_SOURCE_DIR}/src/qml" PARENT_SC
 
 target_compile_definitions(libscratchcpp-gui PRIVATE SCRATCHCPPGUI_LIBRARY)
 
-target_link_libraries(libscratchcpp-gui PRIVATE Qt6::Gui Qt6::Qml Qt6::Quick)
+linkQt(libscratchcpp-gui)
 
 include(build/SetUpLibscratchcpp.cmake)
 target_link_libraries(libscratchcpp-gui PRIVATE scratchcpp)
 
 add_subdirectory(thirdparty/libqnanopainter)
 target_include_directories(libscratchcpp-gui PRIVATE thirdparty/libqnanopainter)
 target_link_libraries(libscratchcpp-gui PRIVATE qnanopainter)
+
+if (SCRATCHCPPGUI_BUILD_UNIT_TESTS)
+    enable_testing()
+    add_subdirectory(test)
+endif()

ScratchCPPGui/CMakeLists.txt

@@ -17,6 +17,7 @@ qt_add_qml_module(libscratchcpp-gui
 	stagemodel.h
 	spritemodel.cpp
 	spritemodel.h
+	irenderedtarget.h
         renderedtarget.cpp
         renderedtarget.h
 	targetpainter.cpp

ScratchCPPGui/irenderedtarget.h

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+
+#pragma once
+
+#include <qnanoquickitem.h>
+
+class QBuffer;
+
+namespace libscratchcpp
+{
+
+class Costume;
+class IEngine;
+class Target;
+
+} // namespace libscratchcpp
+
+namespace scratchcppgui
+{
+
+class StageModel;
+class SpriteModel;
+
+class IRenderedTarget : public QNanoQuickItem
+{
+    public:
+        IRenderedTarget(QNanoQuickItem *parent = nullptr) :
+            QNanoQuickItem(parent)
+        {
+        }
+
+        virtual ~IRenderedTarget() { }
+
+        virtual void loadProperties() = 0;
+        virtual void loadCostume(libscratchcpp::Costume *costume) = 0;
+        virtual void updateProperties() = 0;
+
+        virtual libscratchcpp::IEngine *engine() const = 0;
+        virtual void setEngine(libscratchcpp::IEngine *newEngine) = 0;
+
+        virtual StageModel *stageModel() const = 0;
+        virtual void setStageModel(StageModel *newStageModel) = 0;
+
+        virtual SpriteModel *spriteModel() const = 0;
+        virtual void setSpriteModel(SpriteModel *newSpriteModel) = 0;
+
+        virtual libscratchcpp::Target *scratchTarget() const = 0;
+
+        virtual qreal width() const = 0;
+        virtual void setWidth(qreal width) = 0;
+
+        virtual qreal height() const = 0;
+        virtual void setHeight(qreal width) = 0;
+
+        virtual double costumeWidth() const = 0;
+        virtual void setCostumeWidth(double width) = 0;
+
+        virtual double costumeHeight() const = 0;
+        virtual void setCostumeHeight(double width) = 0;
+
+        virtual unsigned char *svgBitmap() const = 0;
+        virtual QBuffer *bitmapBuffer() = 0;
+        virtual const QString &bitmapUniqueKey() const = 0;
+
+        virtual void lockCostume() = 0;
+        virtual void unlockCostume() = 0;
+
+        virtual bool mirrorHorizontally() const = 0;
+};
+
+} // namespace scratchcppgui

ScratchCPPGui/projectloader.cpp

@@ -34,7 +34,7 @@ ProjectLoader::~ProjectLoader()
     if (m_loadThread.isRunning())
         m_loadThread.waitForFinished();
 
-    if (m_engine) {
+    if (m_engine && m_eventLoopEnabled) {
         m_engine->stopEventLoop();
         m_eventLoop.waitForFinished();
     }
@@ -88,6 +88,12 @@ IEngine *ProjectLoader::engine() const
     return m_engine;
 }
 
+// NOTE: This should be only used for testing
+void ProjectLoader::setEngine(libscratchcpp::IEngine *engine)
+{
+    m_engine = engine;
+}
+
 StageModel *ProjectLoader::stage()
 {
     if (m_loadThread.isRunning())
@@ -104,6 +110,11 @@ QQmlListProperty<SpriteModel> ProjectLoader::sprites()
     return QQmlListProperty<SpriteModel>(this, &m_sprites);
 }
 
+const QList<SpriteModel *> &ProjectLoader::spriteList() const
+{
+    return m_sprites;
+}
+
 void ProjectLoader::start()
 {
     if (m_loadThread.isRunning())
@@ -198,7 +209,10 @@ void ProjectLoader::load()
 
     // Run event loop
     m_engine->setSpriteFencingEnabled(false);
-    m_eventLoop = QtConcurrent::run(&runEventLoop, m_engine);
+
+    if (m_eventLoopEnabled)
+        m_eventLoop = QtConcurrent::run(&runEventLoop, m_engine);
+
     m_engineMutex.unlock();
 
     emit loadStatusChanged();
@@ -244,11 +258,13 @@ void ProjectLoader::setFps(double newFps)
     if (qFuzzyCompare(m_fps, newFps))
         return;
 
-    m_fps = newFps;
     m_engineMutex.lock();
 
-    if (m_engine)
-        m_engine->setFps(m_fps);
+    if (m_engine) {
+        m_engine->setFps(newFps);
+        m_fps = m_engine->fps();
+    } else
+        m_fps = newFps;
 
     m_engineMutex.unlock();
     emit fpsChanged();
@@ -324,11 +340,13 @@ void ProjectLoader::setCloneLimit(int newCloneLimit)
     if (m_cloneLimit == newCloneLimit)
         return;
 
-    m_cloneLimit = newCloneLimit;
     m_engineMutex.lock();
 
-    if (m_engine)
-        m_engine->setCloneLimit(m_cloneLimit);
+    if (m_engine) {
+        m_engine->setCloneLimit(newCloneLimit);
+        m_cloneLimit = m_engine->cloneLimit();
+    } else
+        m_cloneLimit = newCloneLimit;
 
     m_engineMutex.unlock();
     emit cloneLimitChanged();
@@ -353,3 +371,29 @@ void ProjectLoader::setSpriteFencing(bool newSpriteFencing)
     m_engineMutex.unlock();
     emit spriteFencingChanged();
 }
+
+bool ProjectLoader::eventLoopEnabled() const
+{
+    return m_eventLoopEnabled;
+}
+
+void ProjectLoader::setEventLoopEnabled(bool newEventLoopEnabled)
+{
+    if (m_eventLoopEnabled == newEventLoopEnabled)
+        return;
+
+    m_eventLoopEnabled = newEventLoopEnabled;
+    m_engineMutex.lock();
+
+    if (m_engine) {
+        if (m_eventLoopEnabled)
+            m_eventLoop = QtConcurrent::run(&runEventLoop, m_engine);
+        else {
+            m_engine->stopEventLoop();
+            m_eventLoop.waitForFinished();
+        }
+    }
+
+    m_engineMutex.unlock();
+    emit eventLoopEnabledChanged();
+}

ScratchCPPGui/projectloader.h

@@ -29,6 +29,7 @@ class ProjectLoader : public QObject
         Q_PROPERTY(unsigned int stageHeight READ stageHeight WRITE setStageHeight NOTIFY stageHeightChanged)
         Q_PROPERTY(int cloneLimit READ cloneLimit WRITE setCloneLimit NOTIFY cloneLimitChanged)
         Q_PROPERTY(bool spriteFencing READ spriteFencing WRITE setSpriteFencing NOTIFY spriteFencingChanged)
+        Q_PROPERTY(bool eventLoopEnabled READ eventLoopEnabled WRITE setEventLoopEnabled NOTIFY eventLoopEnabledChanged)
 
     public:
         explicit ProjectLoader(QObject *parent = nullptr);
@@ -40,17 +41,16 @@ class ProjectLoader : public QObject
         bool loadStatus() const;
 
         libscratchcpp::IEngine *engine() const;
+        void setEngine(libscratchcpp::IEngine *engine);
 
         StageModel *stage();
 
         QQmlListProperty<SpriteModel> sprites();
+        const QList<SpriteModel *> &spriteList() const;
 
         Q_INVOKABLE void start();
         Q_INVOKABLE void stop();
 
-        unsigned int frameFinished() const;
-        void setFrameFinished(unsigned int newFrameFinished);
-
         double fps() const;
         void setFps(double newFps);
 
@@ -69,6 +69,9 @@ class ProjectLoader : public QObject
         bool spriteFencing() const;
         void setSpriteFencing(bool newSpriteFencing);
 
+        bool eventLoopEnabled() const;
+        void setEventLoopEnabled(bool newEventLoopEnabled);
+
     signals:
         void fileNameChanged();
         void loadStatusChanged();
@@ -82,6 +85,7 @@ class ProjectLoader : public QObject
         void stageHeightChanged();
         void cloneLimitChanged();
         void spriteFencingChanged();
+        void eventLoopEnabledChanged();
 
     protected:
         void timerEvent(QTimerEvent *event) override;
@@ -108,6 +112,7 @@ class ProjectLoader : public QObject
         unsigned int m_stageHeight = 360;
         int m_cloneLimit = 300;
         bool m_spriteFencing = true;
+        bool m_eventLoopEnabled = true;
 };
 
 } // namespace scratchcppgui