[plugin] Draft: Develop Blender plugin

.github/workflows/packaging-pipeline.yml

@@ -4,6 +4,8 @@ name: OpenCue Packaging Pipeline
 on:
   push:
     branches: [ master ]
+  pull_request:
+    branches: [ master ]
 
 jobs:
   integration_test:
@@ -16,6 +18,15 @@ jobs:
       - name: Run test
         run: ci/run_integration_test.sh
 
+      - name: Build blender addon
+        run: ci/build_blender_addon.sh
+
+      - name: Upload blender addon artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: OpenCue-Blender
+          path: ${GITHUB_WORKSPACE}/artifacts/OpenCue-Blender.zip
+
       - name: Archive log files
         uses: actions/upload-artifact@v3
         if: ${{ always() }}
@@ -57,6 +68,10 @@ jobs:
             NAME: CueAdmin
             ARTIFACTS: cueadmin-${BUILD_ID}-all.tar.gz
 
+          - component: OpenCue_Blender
+            NAME: OpenCue-Blender
+            ARTIFACTS: OpenCue-Blender-${BUILD_ID}-all.zip
+
     name: Build ${{ matrix.NAME }}
     runs-on: ubuntu-22.04
     steps:
@@ -97,6 +112,15 @@ jobs:
           context: .
           push: true
 
+      - name: Build Blender addon Docker image
+        if: matrix.component == 'OpenCue_Blender'
+        uses: docker/build-push-action@v3
+        with:
+          file: cuesubmit/plugins/blender/${{ matrix.component }}/Dockerfile
+          tags: opencuebuild/${{ matrix.component }}:${{ env.BUILD_ID }}
+          context: .
+          push: true
+
       - name: Extract Artifacts
         run: |
           set -e

ci/build_blender_addon.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+#  Copyright Contributors to the OpenCue Project
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+# OpenCue integration test script
+#
+# Stands up a clean environment using Docker compose and verifies all
+# components are functioning as expected.
+#
+# Run with:
+#   ./ci/build_blender_addon.sh
+
+set -e
+
+PYOUTLINE_PATH="pyoutline/outline"
+FILESEQUENCE_PATH="pycue/FileSequence"
+OPENCUE_PATH="pycue/opencue"
+
+ADDON_PATH="cuesubmit/plugins/blender/OpenCue-Blender/"
+
+log() {
+    echo "$(date "+%Y-%m-%d %H:%M:%S") $1 $2"
+}
+
+copy_dependencies() {
+  DEPENDENCIES_PATH="${ADDON_PATH}/dependencies"
+  mkdir -p "${DEPENDENCIES_PATH}"
+  cp -r "${PYOUTLINE_PATH}" "${DEPENDENCIES_PATH}"
+  cp -r "${FILESEQUENCE_PATH}" "${DEPENDENCIES_PATH}"
+  cp -r "${OPENCUE_PATH}" "${DEPENDENCIES_PATH}"
+}
+
+main() {
+  log INFO "Copying dependencies into ${ADDON_PATH}"
+  copy_dependencies
+  # Check if script is running within GitHub Actions pipeline
+  if [ "$GITHUB_ACTIONS" == "true" ]; then
+    log INFO "Generating zip in ${GITHUB_WORKSPACE}/artifacts/"
+    mkdir -p "${GITHUB_WORKSPACE}/artifacts/"
+    cd cuesubmit/plugins/blender
+    zip -r "${GITHUB_WORKSPACE}/artifacts/OpenCue-Blender.zip" OpenCue-Blender/
+  else
+    log INFO "Generating zip in cuesubmit/plugins/blender/"
+    cd cuesubmit/plugins/blender
+    zip -r "OpenCue-Blender.zip" OpenCue-Blender/
+  fi
+}
+
+main

ci/run_integration_test.sh

@@ -188,8 +188,40 @@ run_job() {
     log INFO "Job succeeded (PASS)"
 }
 
+run_blender_job() {
+    cp samples/pyoutline/sample.blend $RQD_ROOT
+    samples/pyoutline/blender_job.py
+    job_name="testing-shot02-${USER}_blender_job"
+    samples/pycue/wait_for_job.py "${job_name}" --timeout 300
+    log INFO "Blender job succeeded (PASS)"
+}
+
+add_RQD_tag() {
+    container_id=$(docker ps --filter "name=blender" --format "{{.ID}}")
+    got_hosts=$(python -c 'import opencue; print([host.name() for host in opencue.api.getHosts()])')
+    host_exists=false
+    for host in $(echo "${got_hosts}" | tr -d '[],' | tr -d "'" | tr ' ' '\n'); do
+      if [[ "$host" == "$container_id" ]]; then
+          host_exists=true
+          break
+      fi
+    done
+
+    if [[ "$host_exists" == true ]]; then
+      log INFO "Adding tag to Blender RQD"
+      python -c "import opencue; import opencue.wrappers.host; \
+                  host=opencue.api.findHost('${container_id}'); \
+                  tags = ['blender']; \
+                  host.addTags(tags)"
+    else
+        log ERROR "Blender RQD not detected by Cuebot. Unable to add tag"
+        exit 1
+    fi
+}
+
 cleanup() {
     docker compose rm --stop --force >>"${DOCKER_COMPOSE_LOG}" 2>&1
+    docker rm -f blender
     rm -rf "${RQD_ROOT}" || true
     rm -rf "${DB_DATA_DIR}" || true
     rm -rf "${VENV}" || true
@@ -222,9 +254,11 @@ main() {
     log INFO "$(docker compose version)"
 
     log INFO "Building Cuebot image..."
-    docker build -t opencue/cuebot -f cuebot/Dockerfile . &>"${TEST_LOGS}/docker-build-cuebot.log"
+#    docker build -t opencue/cuebot -f cuebot/Dockerfile . &>"${TEST_LOGS}/docker-build-cuebot.log"
     log INFO "Building RQD image..."
     docker build -t opencue/rqd -f rqd/Dockerfile . &>"${TEST_LOGS}/docker-build-rqd.log"
+    log INFO "Building RQD Blender image..."
+    docker build -t opencue/blender -f samples/rqd/blender/Dockerfile . &>"${TEST_LOGS}/docker-build-rqd-blender.log"
 
     log INFO "Starting Docker compose..."
     docker compose up &>"${DOCKER_COMPOSE_LOG}" &
@@ -251,6 +285,25 @@ main() {
 
     run_job
 
+    log INFO "Starting RQD Blender..."
+    docker run -td --name blender \
+    --env CUEBOT_HOSTNAME=cuebot \
+    --volume "/tmp/rqd/shots:/tmp/rqd/shots" \
+    --volume "/tmp/rqd/logs:/tmp/rqd/logs" \
+    -p 8441:8441 \
+    --network opencue_default \
+    opencue/blender
+
+    docker exec blender sh -c 'echo "RQD_USE_IP_AS_HOSTNAME=False" >> /etc/opencue/rqd.conf'
+    log INFO "Restarting RQD Blender..."
+    docker restart blender
+    sleep 3
+
+    add_RQD_tag
+
+    log INFO "Testing Blender job..."
+    run_blender_job
+
     cleanup
 
     log INFO "Success"

cuesubmit/plugins/blender/OpenCue-Blender/Setup.py

@@ -0,0 +1,117 @@
+#  Copyright Contributors to the OpenCue Project
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import shutil
+import sys
+import subprocess
+import os
+import platform
+import bpy
+
+blender_dependencies_directory = "lib/python3.10/site-packages"
+blender_dependencies_path = os.path.join(sys.prefix, blender_dependencies_directory)
+opencue_blender_path = os.path.dirname(__file__)
+
+pyoutline_path = os.path.join(opencue_blender_path, "dependencies", "outline")
+filesequence_path = os.path.join(opencue_blender_path, "dependencies", "FileSequence")
+opencue_path = os.path.join(opencue_blender_path, "dependencies", "opencue")
+
+pyoutline_directory = "outline"
+opencue_imported_directory = "opencue"
+filesequence_imported_directory = "FileSequence"
+pyoutline_directory_path = os.path.join(sys.prefix, blender_dependencies_directory, pyoutline_directory)
+opencue_directory_path = os.path.join(sys.prefix, blender_dependencies_directory, opencue_imported_directory)
+filesequence_directory_path = os.path.join(sys.prefix, blender_dependencies_directory, filesequence_imported_directory)
+
+
+def isWindows():
+    """Checks if host OS is Windows"""
+    return os.name == 'nt'
+
+
+def isMacOS():
+    """Checks if host OS is macOS"""
+    return os.name == 'posix' and platform.system() == "Darwin"
+
+
+def isLinux():
+    """Checks if host OS is Linux"""
+    return os.name == 'posix' and platform.system() == "Linux"
+
+
+def python_exec():
+    """Sets Blender local python based on host OS"""
+    if isWindows():
+        return os.path.join(sys.prefix, 'bin', 'python.exe')
+    elif isMacOS():
+        try:
+            # 2.92 and older
+            path = bpy.app.binary_path_python
+        except AttributeError:
+            # 2.93 and later
+            path = sys.executable
+        return os.path.abspath(path)
+    elif isLinux():
+        return os.path.join(sys.prefix, 'bin', 'python3.10')  # Works on Blender 3.3.1 LTS
+    else:
+        print("sorry, still not implemented for ", os.name, " - ", platform.system)
+        return os.path.join(sys.prefix, 'sys.prefix/bin', 'python')
+
+
+def installModule():
+    """Installs all addon dependencies during registration"""
+    # Install OpenCue dependencies
+    installOpencueModules()
+
+    # installs External modules from requirements.txt file
+    installExternalModules()
+
+    print("\n----- OpenCue-Blender Installed Successfully -----")
+
+
+def installExternalModules():
+    """Installs externals dependencies onto Blender python environment with pip"""
+    # Get path of requirements file
+    script_file = os.path.realpath(__file__)
+    directory = os.path.dirname(script_file)
+    file_name = "requirements.txt"
+    requirements = os.path.join(directory, file_name)
+
+    # identify for platform
+    python_exe = python_exec()
+
+    # upgrade pip
+    print("\n----- Installing External Dependencies -----")
+    subprocess.call([python_exe, "-m", "ensurepip"])
+    subprocess.call([python_exe, "-m", "pip", "install", "--upgrade", "pip"])
+    # install required external packages
+    subprocess.call([python_exe, "-m", "pip", "install", "-r", requirements, "-t", blender_dependencies_path])
+    print("\n----- External Dependencies Installed Successfully -----")
+
+
+def installOpencueModules():
+    """Installs OpenCue dependencies onto Blender python environment"""
+    print("----- Installing OpenCue Dependencies -----")
+    shutil.copytree(pyoutline_path, pyoutline_directory_path)
+    shutil.copytree(opencue_path, opencue_directory_path)
+    shutil.copytree(filesequence_path, filesequence_directory_path)
+    print("\n----- OpenCue Dependencies Installed Successfully -----")
+
+
+def removeOpencueModules():
+    """Removes OpenCue dependencies from Blender python environment"""
+    # remove installed opencue dependencies
+    shutil.rmtree(pyoutline_directory_path)
+    shutil.rmtree(opencue_directory_path)
+    shutil.rmtree(filesequence_directory_path)