Merge pull request #1 from scratchcpp/utests

Add unit tests

Author: adazem009

.github/workflows/utests.yml

@@ -0,0 +1,33 @@
+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: true
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y nlohmann-json3-dev libutfcpp-dev
+      shell: bash
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DLIBSCRATCHCPP_BUILD_UNIT_TESTS=ON
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Run unit tests
+      run: ctest --test-dir build -V

.gitmodules

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

CMakeLists.txt

@@ -7,11 +7,14 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(ZIP_SRC thirdparty/zip/src)
 
+option(LIBSCRATCHCPP_BUILD_UNIT_TESTS "Build unit tests" ON)
+
 find_package(nlohmann_json 3.9.1 REQUIRED)
 find_package(utf8cpp REQUIRED)
 
 add_library(scratchcpp SHARED)
 add_subdirectory(src)
+include_directories(src)
 
 add_library(zip SHARED
 	${ZIP_SRC}/zip.c
@@ -25,3 +28,8 @@ target_link_libraries(scratchcpp PRIVATE utf8cpp)
 target_link_libraries(scratchcpp PRIVATE zip)
 
 target_compile_definitions(scratchcpp PRIVATE LIBSCRATCHCPP_LIBRARY)
+
+if (LIBSCRATCHCPP_BUILD_UNIT_TESTS)
+    enable_testing()
+    add_subdirectory(test)
+endif()

src/engine/engine.cpp

@@ -27,12 +27,11 @@ void Engine::clear()
 }
 
 /*!
- * Compiles all scripts to bytecode.
- * \see Compiler
+ * Resolves ID references and sets pointers of entities.
+ * \note This function shouldn't normally be called because it's called from compile().
  */
-void Engine::compile()
+void Engine::resolveIds()
 {
-    // Resolve entities by ID
     for (auto target : m_targets) {
         std::cout << "Processing target " << target->name() << "..." << std::endl;
         auto blocks = target->blocks();
@@ -66,6 +65,16 @@ void Engine::compile()
             block->updateFieldMap();
         }
     }
+}
+
+/*!
+ * Compiles all scripts to bytecode.
+ * \see Compiler
+ */
+void Engine::compile()
+{
+    // Resolve entities by ID
+    resolveIds();
 
     // Compile scripts to bytecode
     for (auto target : m_targets) {
@@ -277,6 +286,12 @@ void Engine::breakFrame()
     m_breakFrame = true;
 }
 
+/*! Returns true if breakFrame() was called. */
+bool libscratchcpp::Engine::breakingCurrentFrame()
+{
+    return m_breakFrame;
+}
+
 /*! Registers the given block section. */
 void Engine::registerSection(std::shared_ptr<IBlockSection> section)
 {
@@ -423,6 +438,12 @@ void Engine::setExtensions(const std::vector<std::string> &newExtensions)
     }
 }
 
+/*! Returns the map of scripts (each top level block has a Script object). */
+const std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> &Engine::scripts() const
+{
+    return m_scripts;
+}
+
 /*! Returns the block with the given ID. */
 std::shared_ptr<Block> Engine::getBlock(std::string id)
 {

src/engine/engine.h

@@ -30,6 +30,7 @@ class LIBSCRATCHCPP_EXPORT Engine
         Engine(const Engine &) = delete;
 
         void clear();
+        void resolveIds();
         void compile();
 
         void frame();
@@ -44,6 +45,7 @@ class LIBSCRATCHCPP_EXPORT Engine
         bool broadcastRunning(unsigned int index);
 
         void breakFrame();
+        bool breakingCurrentFrame();
 
         void registerSection(std::shared_ptr<IBlockSection> section);
         unsigned int functionIndex(BlockFunc f);
@@ -65,6 +67,8 @@ class LIBSCRATCHCPP_EXPORT Engine
         std::vector<std::string> extensions() const;
         void setExtensions(const std::vector<std::string> &newExtensions);
 
+        const std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> &scripts() const;
+
     private:
         std::shared_ptr<Block> getBlock(std::string id);
         std::shared_ptr<Variable> getVariable(std::string id);

src/engine/script.cpp

@@ -17,6 +17,12 @@ unsigned int *Script::bytecode() const
     return m_bytecode;
 }
 
+/*! Returns the bytecode vector. */
+const std::vector<unsigned int> &Script::bytecodeVector() const
+{
+    return m_bytecodeVector;
+}
+
 /*! Sets the bytecode of the script. */
 void Script::setBytecode(const std::vector<unsigned int> &code)
 {

src/engine/script.h

@@ -15,6 +15,7 @@ class LIBSCRATCHCPP_EXPORT Script
         Script(const Script &) = delete;
 
         unsigned int *bytecode() const;
+        const std::vector<unsigned int> &bytecodeVector() const;
         void setBytecode(const std::vector<unsigned int> &code);
 
         void setProcedures(const std::vector<unsigned int *> &procedures);

src/engine/virtualmachine.cpp

@@ -431,8 +431,12 @@ do_loop_end : {
 
 do_round : {
     const Value *v = READ_REG(0, 1);
-    if (!v->isInfinity() && !v->isNegativeInfinity())
-        REPLACE_RET_VALUE(static_cast<long>(std::round(v->toDouble())), 1);
+    if (!v->isInfinity() && !v->isNegativeInfinity()) {
+        if (v->toDouble() < 0) {
+            REPLACE_RET_VALUE(static_cast<long>(std::floor(v->toDouble() + 0.5)), 1);
+        } else
+            REPLACE_RET_VALUE(static_cast<long>(v->toDouble() + 0.5), 1);
+    }
     DISPATCH();
 }
 
@@ -491,7 +495,11 @@ do_tan : {
     if (v->isInfinity() || v->isNegativeInfinity())
         REPLACE_RET_VALUE(Value(Value::SpecialValue::NaN), 1);
     else {
-        long mod = v->toLong() % 360;
+        long mod;
+        if (v->toLong() < 0)
+            mod = (v->toLong() + 360) % 360;
+        else
+            mod = v->toLong() % 360;
         if (mod == 90)
             REPLACE_RET_VALUE(Value(Value::SpecialValue::Infinity), 1);
         else if (mod == 270)
@@ -522,8 +530,10 @@ do_acos : {
 
 do_atan : {
     const Value &v = *READ_REG(0, 1);
-    if (v < -1 || v > 1)
-        REPLACE_RET_VALUE(Value(Value::SpecialValue::NaN), 1);
+    if (v.isInfinity())
+        REPLACE_RET_VALUE(90, 1);
+    else if (v.isNegativeInfinity())
+        REPLACE_RET_VALUE(-90, 1);
     else
         REPLACE_RET_VALUE(std::atan(v.toDouble()) * 180 / pi, 1);
     DISPATCH();

src/engine/virtualmachine.h

@@ -102,6 +102,9 @@ class LIBSCRATCHCPP_EXPORT VirtualMachine
 
         void setBytecode(unsigned int *code);
 
+        /*! Returns the array of constant values. */
+        const Value *constValues() const { return m_constValues; };
+
         /*! Returns the bytecode array. */
         unsigned int *bytecode() const { return m_bytecode; };
 

src/internal/iprojectreader.h

@@ -19,6 +19,7 @@ class LIBSCRATCHCPP_EXPORT IProjectReader
 
         virtual bool load() = 0;
         virtual bool isValid() = 0;
+        virtual void clear() = 0;
         virtual std::vector<std::shared_ptr<Target>> targets() = 0;
         virtual std::vector<std::shared_ptr<Broadcast>> broadcasts() = 0;
         virtual std::vector<std::string> extensions() = 0;