Ci improvement test

.github/actions/install-dependencies-composite-action/action.yml

@@ -12,6 +12,10 @@ runs:
       shell: bash
       run: sudo apt-get update -y && sudo apt-get install -y cmake
 
+    - name: Install Ninja
+      shell: bash
+      run: sudo apt-get install -y ninja-build
+
     - name: Install Qt
       uses: jurplel/install-qt-action@v4
       with:
@@ -22,4 +26,37 @@ runs:
 
     - name: Install OpenAL
       shell: bash
-      run: sudo apt-get install -y libopenal-dev
+      run: sudo apt-get install -y libopenal-dev
+
+    - name: Install GTest
+      shell: bash
+      run: sudo apt-get install -y libgtest-dev
+
+    - name: Install gcovr
+      shell: bash
+      run: sudo apt-get install -y gcovr
+
+    - name: Install xvbf
+      shell: bash
+      run: sudo apt-get install -y xvfb libxcb-cursor0
+
+    - name: Install AnyRPC
+      shell: bash
+      run: |
+        git clone https://github.com/sgieseking/anyrpc.git
+        cd anyrpc
+        mkdir build
+        cd build
+        cmake -DBUILD_EXAMPLES=OFF -DBUILD_WITH_LOG4CPLUS=OFF -DBUILD_PROTOCOL_MESSAGEPACK=OFF ..
+        cmake --build .
+        sudo cmake --install .
+
+    - name: Install Spix
+      shell: bash
+      run: |
+        git clone https://github.com/faaxm/spix
+        cd spix
+        mkdir build && cd build
+        cmake -DSPIX_QT_MAJOR=6 -SPIX_BUILD_EXAMPLES=OFF ..
+        cmake --build .
+        sudo cmake --install .

.github/workflows/build.yml

@@ -1,10 +1,39 @@
-name: Build master
+name: Build and test
 
 on:
   push:
     branches: [ master ]
+    paths:
+    - 'data/**/*.js'   
+    - 'Engine/**'
+    - 'ImagePlugin/**'
+    - 'include/**'
+    - 'QM/**'
+    - 'QML/**'
+    - 'Ranger/**'
+    - 'tests/**'
+    - 'tools/**'
+    - 'World/**'
+    - 'CMakeLists.txt'
+    - '**/CMakeLists.txt'
+    - 'opensr_setup.sh'
+
   pull_request:
     branches: [ master ]
+    paths:
+    - 'data/**/*.js'   
+    - 'Engine/**'
+    - 'ImagePlugin/**'
+    - 'include/**'
+    - 'QM/**'
+    - 'QML/**'
+    - 'Ranger/**'
+    - 'tests/**'
+    - 'tools/**'
+    - 'World/**'
+    - 'CMakeLists.txt'
+    - '**/CMakeLists.txt'
+    - 'opensr_setup.sh'
 
 env:
   BUILD_TYPE: Debug
@@ -21,7 +50,13 @@ jobs:
         uses: ./.github/actions/install-dependencies-composite-action
 
       - name: Configure CMake
-        run: cmake -S . -B build -DBUILD_ALL_TOOLS=Yes -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
+        run: cmake -G Ninja -S . -B build -DBUILD_ALL_TOOLS=Yes -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DBUILD_TESTS=Yes
 
       - name: Build
-        run: cmake --build build -j
+        run: cmake --build build --parallel $(nproc)
+
+      - name: Create symlinks to plugins
+        run: ./opensr_setup.sh -t demo
+
+      - name: Run tests
+        run: cd build/ && xvfb-run --auto-servernum --server-args="-screen 0 1280x1024x24" ctest -VV

.github/workflows/coverage.yml

@@ -0,0 +1,66 @@
+name: Code coverage
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+    - 'data/**/*.js'  
+    - 'Engine/**'
+    - 'ImagePlugin/**'
+    - 'include/**'
+    - 'QM/**'
+    - 'QML/**'
+    - 'Ranger/**'
+    - 'tests/**'
+    - 'tools/**'
+    - 'World/**'
+    - 'CMakeLists.txt'
+    - '**/CMakeLists.txt'
+
+  pull_request:
+    branches: [ master ]
+    paths:
+    - 'data/**/*.js'   
+    - 'Engine/**'
+    - 'ImagePlugin/**'
+    - 'include/**'
+    - 'QM/**'
+    - 'QML/**'
+    - 'Ranger/**'
+    - 'tests/**'
+    - 'tools/**'
+    - 'World/**'
+    - 'CMakeLists.txt'
+    - '**/CMakeLists.txt'
+
+env:
+  BUILD_TYPE: Debug
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies-composite-action
+
+      - name: Configure CMake
+        run: cmake -G Ninja -S . -B build -DCMAKE_CXX_COMPILER=g++ -DBUILD_ALL_TOOLS=Yes -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} -DENABLE_COVERAGE=Yes
+
+      - name: Build
+        run: cmake --build build --parallel $(nproc)
+
+      - name: Create symlinks to plugins
+        run: ./opensr_setup.sh -t demo
+
+      - name: Make coverage report
+        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x1024x24" cmake --build build --target global_coverage
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with: 
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: build/coverage/coverage.json

.github/workflows/lint.yml

@@ -25,7 +25,7 @@ jobs:
         uses: ./.github/actions/install-dependencies-composite-action
 
       - name: Configure CMake
-        run: cmake -S . -B build -DBUILD_ALL_TOOLS=Yes -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
+        run: cmake -G Ninja -S . -B build -DCMAKE_CXX_COMPILER=clang++ -DBUILD_ALL_TOOLS=Yes -DBUILD_TESTS=Yes -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
 
       - uses: cpp-linter/cpp-linter-action@v2
         id: linter
@@ -34,7 +34,7 @@ jobs:
         with:
           version: '19'
           database: 'build'
-          ignore: 'QML|data|.github|build|Engine/3rdparty|Engine/shaders|tools'
+          ignore: 'QML|data|.github|build|Engine/3rdparty|Engine/shaders|anyrpc|spix'
           style: 'file'
           tidy-checks: ''
           step-summary: true

.gitignore

@@ -5,6 +5,8 @@ Makefile
 CMakeFiles
 *.user
 CMakeCache.txt
+/.vscode
+/.qt
 # Root build dir
 /build
 /libworld.so

CMakeLists.txt

@@ -1,12 +1,10 @@
-cmake_minimum_required(VERSION 3.16...3.27)
+cmake_minimum_required(VERSION 3.10)
 
 project(OpenSR
     VERSION 0.1.1
     LANGUAGES CXX
 )
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules")
-
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 set(CMAKE_CXX_STANDARD 20)
@@ -19,13 +17,45 @@ set(CMAKE_AUTOUIC ON)
 
 set(API_VERSION 1)
 
-find_package(Qt6 REQUIRED COMPONENTS Core Gui)
-
 option(BUILD_ALL_TOOLS "Build all tools (overrides individual tool options)" OFF)
 option(BUILD_RESOURCE_VIEWER "Build Resource Viewer tool" OFF)
 option(BUILD_PLANET_VIEWER "Build Planet Viewer tool" OFF)
 option(BUILD_QUEST_PLAYER "Build Quest Player tool" OFF)
 option(BUILD_DAT_TOOLS "Build tools for DAT files" OFF)
+option(BUILD_TESTS "Build project unit tests and tests for UI components" OFF)
+option(ENABLE_COVERAGE "Enable code covereage (turns test building on)" OFF)
+
+if(ENABLE_COVERAGE)
+    set(BUILD_TESTS ON)
+
+    add_compile_options(--coverage -g -O0 -fprofile-arcs)
+    add_link_options(--coverage -fprofile-arcs)
+
+    find_program(GCOVR gcovr REQUIRED)
+
+    file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/coverage)
+
+    add_custom_target(run_all_tests
+        COMMAND find ${CMAKE_BINARY_DIR} -name "*.gcda" -delete
+        COMMAND ${CMAKE_CTEST_COMMAND} -VV
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMENT "Running all tests for coverage"
+    )
+
+    add_custom_target(global_coverage
+        COMMAND ${GCOVR} -r ${CMAKE_SOURCE_DIR} 
+                --exclude '.*/tests'
+                --exclude '.*/moc_.*'
+                --exclude '.*autogen.*'
+                --exclude '.*_autogen.*'
+                --exclude '.*/CMakeFiles/.*'
+                --exclude '.*/.qt'
+                --coveralls -o ${CMAKE_BINARY_DIR}/coverage/coverage.json
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMENT "Generating combined coverage report for all tests"
+        DEPENDS run_all_tests
+    )
+endif()
 
 if(BUILD_ALL_TOOLS)
     set(BUILD_RESOURCE_VIEWER ON)
@@ -40,6 +70,11 @@ add_subdirectory(QM)
 add_subdirectory(Engine)
 add_subdirectory(World)
 
+if (BUILD_TESTS)
+    include(CTest)
+    add_subdirectory(tests)
+endif()
+
 if(BUILD_RESOURCE_VIEWER OR BUILD_PLANET_VIEWER OR BUILD_QUEST_PLAYER OR BUILD_DAT_TOOLS)
     add_subdirectory(tools)
 endif()

Engine/CMakeLists.txt

@@ -1,4 +1,4 @@
-find_package(Qt6 REQUIRED COMPONENTS Widgets Quick ShaderTools)
+find_package(Qt6 REQUIRED COMPONENTS Widgets Quick ShaderTools Gui)
 find_package(OpenAL REQUIRED)
 
 add_library(engine SHARED

Engine/Engine.cpp

@@ -77,6 +77,7 @@ class Engine::EnginePrivate
     QUrl startupScript;
     QUrl mainQML;
     bool running = false;
+    bool testMode = false;
 };
 
 Engine::Engine(int &argc, char **argv) : QApplication(argc, argv), d_osr_ptr(new EnginePrivate())
@@ -95,6 +96,14 @@ Engine::Engine(int &argc, char **argv) : QApplication(argc, argv), d_osr_ptr(new
 
     d->qmlEngine->globalObject().setProperty("Engine", d->qmlEngine->newQObject(this));
     d->qmlEngine->setObjectOwnership(this, QQmlEngine::CppOwnership);
+    d->qmlEngine->rootContext()->setContextProperty("isTestMode", false);
+
+    d->testMode = arguments().contains("--test-mode");
+
+    if (d->testMode)
+    {
+        d->qmlEngine->rootContext()->setContextProperty("isTestMode", true);
+    }
 }
 
 Engine::~Engine()
@@ -146,7 +155,13 @@ int Engine::run()
 
     auto scriptExec = [this] {
         Q_D(Engine);
-        if (!d->startupScript.isEmpty())
+
+        if (d->testMode)
+        {
+            execScript(QUrl("res:/opensrTestMode.js"));
+            return;
+        }
+        if (!d->startupScript.isEmpty() && !d->testMode)
         {
             execScript(d->startupScript);
         }
@@ -178,7 +193,8 @@ void Engine::showQMLComponent(const QString &url)
 
     for (auto root : d->qmlEngine->rootObjects())
     {
-        QMetaObject::invokeMethod(root, "destroyAndChangeScreen", Q_ARG(QVariant, QUrl(url)), Q_ARG(QVariant, QVariantMap()));
+        QMetaObject::invokeMethod(root, "destroyAndChangeScreen", Q_ARG(QVariant, QUrl(url)),
+                                  Q_ARG(QVariant, QVariantMap()));
     }
 }
 

Engine/GAIAnimatedImage.cpp

@@ -58,7 +58,7 @@ class GAIAnimatedImage::GAIAnimatedImagePrivate
     QList<QVector<QPoint>> m_gaiOffsets;
     QTimer m_timer;
 
-    std::vector<std::unique_ptr<GAITexture>> m_textures;
+    std::vector<std::shared_ptr<GAITexture>> m_textures;
     long long m_currentFile = 0;
     bool m_fileChanged = false;
     bool m_playing = true;
@@ -168,7 +168,7 @@ QSGNode *GAIAnimatedImage::updatePaintNode(QSGNode *oldNode, QQuickItem::UpdateP
 
     if (d->m_fileChanged)
     {
-        material->setTexture(d->m_textures[d->m_currentFile].get());
+        material->setTexture(d->m_textures[d->m_currentFile]);
         node->markDirty(QSGNode::DirtyMaterial);
         d->m_fileChanged = false;
     }

Engine/GAIMaterial.cpp

@@ -1,5 +1,6 @@
 #include "GAIMaterial.h"
 #include "GAIShader.h"
+#include <memory>
 
 namespace OpenSR
 {
@@ -21,10 +22,10 @@ QSGMaterialShader *GAIMaterial::createShader(QSGRendererInterface::RenderMode) c
 
 GAITexture *GAIMaterial::texture() const
 {
-    return m_texture;
+    return m_texture.get();
 }
 
-void GAIMaterial::setTexture(GAITexture *texture)
+void GAIMaterial::setTexture(std::shared_ptr<GAITexture> texture)
 {
     m_texture = texture;
 }

Engine/GAIMaterial.h

@@ -14,9 +14,9 @@ class GAIMaterial : public QSGMaterial
     QSGMaterialType *type() const override;
     QSGMaterialShader *createShader(QSGRendererInterface::RenderMode) const override;
     GAITexture *texture() const;
-    void setTexture(GAITexture *texture);
+    void setTexture(std::shared_ptr<GAITexture> texture);
 
 private:
-    GAITexture *m_texture;
+    std::shared_ptr<GAITexture> m_texture;
 };
 } // namespace OpenSR

Engine/ResourceManager_p.h

@@ -22,6 +22,7 @@
 #include "OpenSR/ResourceManager.h"
 
 #include <OpenSR/libRangerQt.h>
+#include <QDir>
 #include <QNetworkReply>
 
 class QFile;