Add unit testing environment

.github/workflows/docs.yml

@@ -24,13 +24,13 @@ jobs:
     name: Build documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
+      - uses: actions/checkout@v3.3.0
 
-      - uses: actions/setup-python@v4.3.0
+      - uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.10"
 
-      - uses: syphar/restore-virtualenv@v1.2
+      - uses: syphar/restore-virtualenv@v1.3
         id: cache-virtualenv
         with:
           requirement_files: requirements.txt
@@ -45,15 +45,15 @@ jobs:
         run: pip install -r requirements.txt
 
       - name: Cache docs build directory
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v3.2.5
         if: env.USE_CACHE == 'true'
         with:
           path: docs/build/
           key: docs-build-${{ hashFiles('docs/source/conf.py') }}
 
       - name: Cache animation nodes source code
         id: animation-nodes-source-code
-        uses: actions/cache@v3.0.11
+        uses: actions/cache@v3.2.5
         if: env.USE_CACHE == 'true'
         with:
           path: animation_nodes/
@@ -94,7 +94,7 @@ jobs:
           cp -r docs/build/html build_docs
           zip -r build_docs build_docs
 
-      - uses: actions/upload-artifact@v3.1.1
+      - uses: actions/upload-artifact@v3.1.2
         if: env.DEPLOY == 'true'
         with:
           name: build_docs
@@ -106,9 +106,9 @@ jobs:
     needs: build
     if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags')
     steps:
-      - uses: actions/checkout@v2.5.0
+      - uses: actions/checkout@v3.3.0
 
-      - uses: actions/download-artifact@v3.0.1
+      - uses: actions/download-artifact@v3.0.2
         with:
           name: build_docs
           path: .

.github/workflows/style.yml

@@ -14,9 +14,9 @@ jobs:
   stylecheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
+      - uses: actions/checkout@v3.3.0
 
-      - uses: actions/setup-python@v4.3.0
+      - uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.10"
 

.github/workflows/unit-testing.yml

@@ -0,0 +1,46 @@
+name: Unit testing
+on:
+  pull_request: # Run in pull requests
+
+  workflow_dispatch: # Allow to run this workflow manually
+
+  push:
+    branches: # Run when there is a push to master
+      - "master"
+
+jobs:
+  Unit-testing:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 4
+      fail-fast: false
+      matrix:
+        blender-version: ["2.93.11", "3.4.1",]
+        os: ["ubuntu-latest", "windows-latest",]
+    env:
+      BLENDER_CACHE: ${{ github.workspace }}/cache # The place where blender releases are downloaded
+      BLENDER_VERSION: ${{ matrix.blender-version }}
+    steps:
+      - uses: actions/checkout@v3.3.0
+
+      - uses: actions/setup-python@v4.5.0
+        with:
+          python-version: "3.10"
+
+      - uses: syphar/restore-virtualenv@v1.3
+        id: cache-virtualenv
+        with:
+          requirement_files: requirements.txt
+
+      - name: Cache Blender release download
+        uses: actions/cache@v3.2.5
+        with:
+          path: ${{ env.BLENDER_CACHE }}
+          key: ${{ matrix.os }}-blender-${{ matrix.blender-version }}
+
+      - name: Install dependencies
+        if: steps.cache-virtualenv.outputs.cache-hit != 'true'
+        run: pip install -r requirements.txt
+
+      - name: Run test suite (Blender ${{ matrix.blender-version }}, ${{ matrix.os }})
+        run: python -m scripts.test -b ${{ matrix.blender-version }} -os ${{ matrix.os }}

.gitignore

@@ -9,8 +9,13 @@ docs/source/developers_manual/code/
 animation_nodes/
 
 # Cache
+.pytest_cache/
 **/__pycache__
+cache/
 
 # Blender
 *.pyc
-*.blend[1-9]
+*.blend[1-9]
+
+# Tests
+local_addon/

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
   hooks:
   - id: flake8
     additional_dependencies: [
-      "flake8-quotes==3.3.1",
+      "flake8-quotes==3.3.2",
     ]
 
 - repo: https://github.com/codespell-project/codespell
@@ -16,7 +16,7 @@ repos:
     ]
 
 - repo: https://github.com/pycqa/pydocstyle
-  rev: 6.1.1
+  rev: 6.3.0
   hooks:
   - id: pydocstyle
     exclude: quantum_nodes/lib/quantumblur.py

docs/Makefile

@@ -1,4 +1,4 @@
-# Minimal makefile for Sphinx documentation
+# Makefile for Sphinx documentation
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.

docs/make.bat

@@ -4,28 +4,25 @@ pushd %~dp0
 
 REM Command file for Sphinx documentation
 
-if "%SPHINXBUILD%" == "" (
+if "%2" == "" (
 	set SPHINXBUILD=sphinx-build
+) else (
+	set SPHINXBUILD=%2
 )
+
 set SOURCEDIR=source
 set BUILDDIR=build
+set MODULE=quantum_nodes
 
 if "%1" == "" goto help
 
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
+move "../%MODULE%/__init__.py" "../%MODULE%/___init__.py"
+powershell -ExecutionPolicy ByPass -command ". replace_matching_string_in_files.ps1 -find '@persistent' -replace '#@persistent';"
 
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+powershell -ExecutionPolicy ByPass -command ". replace_matching_string_in_files.ps1 -find '#@persistent' -replace '@persistent';"
+move "../%MODULE%/___init__.py" "../%MODULE%/__init__.py"
 goto end
 
 :help

docs/replace_matching_string_in_files.ps1

@@ -0,0 +1,23 @@
+# Replace matching strings with another string in the given list of files
+param(
+    [string]$folder = "../quantum_nodes/",
+    [string]$find = "@persistent",
+    [string]$replace = "#@persistent"
+)
+
+[array]$files = Get-ChildItem -Path $folder -Include *.py -Recurse -Force | select -expand fullname
+
+function Find-And-Replace-Strings {
+
+    param(
+        [array]$files,
+        [string]$find,
+        [string]$replace
+    )
+
+    ForEach ($file in $files) {
+        (Get-Content -Path $file -Raw) -replace $find, $replace | Set-Content -Path $file -NoNewLine
+    }
+}
+
+Find-And-Replace-Strings $files $find $replace

docs/source/developers_manual/index.rst

@@ -1,9 +1,46 @@
-Developers manual
-=================
+Contribute to Quantum Nodes
+===========================
+
+
+.. _dev-env-contrib-addon:
+
+Development environment
+#######################
+
 
 .. toctree::
     :maxdepth: 1
+    :glob:
+
+    instructions
+    tools
+
+
+.. _contribute-contrib-addon:
+
+Contribute
+##########
+
+
+.. note::
+    Click `here <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ to learn about the forking workflow on Github.
+
+
+* Fork our `git repository <https://github.com/Quantum-Creative-Group/quantum_nodes>`_
+* Do your modifications
+* Open a new `pull request <https://github.com/Quantum-Creative-Group/quantum_nodes/pulls>`_
+* Wait for your modifications to be reviewed and accepted
+
+
+.. _git-workflow-contrib-addon:
+
+Git workflow
+############
+
+.. image:: https://miro.medium.com/max/560/1*UH5ozOBwkaFhWA1mrJkVIQ.png
+    :alt: Git workflow
+    :align: center
+    :width: 80%
+    :class: img-rounded
 
-    addon/index
-    manual/index
-    code/quantum_nodes
+|