feat: add install builder component (#5)

Signed-off-by: Lucas Eckhardt <[email protected]>

depsBundle.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+set -xeuo pipefail
+
+SCRIPT_FOLDER=$(dirname "$0")/scripts
+
+pushd "${SCRIPT_FOLDER}"
+python deps_bundle.py
+popd
+
+rm -f dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-windows.zip
+rm -f dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-linux.zip
+rm -f dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-macos.zip
+
+mkdir -p dependency_bundle
+
+cp scripts/dependency_bundle/deadline_cloud_for_keyshot_submitter-deps.zip dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-windows.zip
+cp scripts/dependency_bundle/deadline_cloud_for_keyshot_submitter-deps.zip dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-linux.zip
+cp scripts/dependency_bundle/deadline_cloud_for_keyshot_submitter-deps.zip dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-macos.zip

install_builder/deadline-cloud-for-keyshot.xml

@@ -0,0 +1,146 @@
+<component>
+    <name>deadline_cloud_for_keyshot</name>
+    <description>Deadline Cloud for KeyShot 12</description>
+    <detailedDescription>KeyShot plugin for submitting jobs to Amazon Deadline Cloud.</detailedDescription>
+    <canBeEdited>1</canBeEdited>
+    <selected>0</selected>
+    <show>1</show>
+    <folderList>
+        <folder>
+            <description>KeyShot Plug-in Script</description>
+            <destination>${keyshot_scripts_folder}</destination>
+            <name>keyshotplugin</name>
+            <platforms>all</platforms>
+            <distributionFileList>
+                <distributionFile>
+                    <origin>components/deadline-cloud-for-keyshot/keyshot_script/DeadlineCloudSubmitter.py</origin>
+                </distributionFile>
+            </distributionFileList>
+        </folder>
+        <folder>
+            <description>KeyShot Submitter Files</description>
+            <destination>${keyshot_installdir}/keyshot_submitter</destination>
+            <name>keyshot</name>
+            <platforms>all</platforms>
+            <distributionFileList>
+                <distributionDirectory allowWildcards="1">
+                    <origin>components/deadline-cloud-for-keyshot/src/deadline/keyshot_submitter/*</origin>
+                </distributionDirectory>
+            </distributionFileList>
+        </folder>
+        <folder>
+             <description>Dependency Files</description>
+             <destination>${installdir}/tmp/keyshot_deps</destination>
+             <name>keyshotdeps</name>
+             <platforms>all</platforms>
+             <distributionFileList>
+                 <distributionDirectory allowWildcards="1">
+                     <origin>components/deadline-cloud-for-keyshot/dependency_bundle</origin>
+                 </distributionDirectory>
+             </distributionFileList>
+         </folder>
+    </folderList>
+    <initializationActionList>
+        <if>
+            <conditionRuleList>
+                <compareText>
+                    <logic>does_not_contain</logic>
+                    <text>${platform_name}</text>
+                    <value>linux</value>
+                </compareText>
+            </conditionRuleList>
+            <actionList>
+                <setInstallerVariable name="all_components" value="${all_components} deadline_cloud_for_keyshot" />
+            </actionList>
+            <elseActionList>
+                <setInstallerVariable name="component(deadline_cloud_for_keyshot).show" value="0"/>
+            </elseActionList>
+        </if>
+    </initializationActionList>
+    <readyToInstallActionList>
+        <setInstallerVariable name="keyshot_installdir" value="${installdir}\Submitters\KeyShot" />
+        <if>
+            <conditionRuleList>
+                <platformTest type="windows" />
+            </conditionRuleList>
+            <actionList>
+                <setInstallerVariable name="keyshot_deps_platform" value="windows" />
+                <setInstallerVariable name="win_user_keyshot_script_folder" value="${user_home_directory}\Documents\KeyShot 12\Scripts" />
+                <setInstallerVariable name="win_system_keyshot_script_folder" value="${windows_folder_common_documents}\KeyShot 12\Scripts" />
+                <if>
+                    <conditionRuleList>
+                        <fileExists path="${win_user_keyshot_script_folder}" />
+                    </conditionRuleList>
+                    <actionList>
+                        <setInstallerVariable name="keyshot_scripts_folder" value="${win_user_keyshot_script_folder}" />
+                    </actionList>
+                    <elseActionList>
+                        <if>
+                            <conditionRuleList>
+                                <fileExists path="${win_system_keyshot_script_folder}" />
+                            </conditionRuleList>
+                            <actionList>
+                                <setInstallerVariable name="keyshot_scripts_folder" value="${win_system_keyshot_script_folder}" />
+                            </actionList>
+                            <elseActionList>
+                                <setInstallerVariable name="keyshot_scripts_folder" value="${keyshot_installdir}" />
+                                <showWarning text="No installation of KeyShot 12 was found. Please manually move the DeadlineCloudSubmitter.py script into the KeyShot scripts folder to use the plug-in." />
+                            </elseActionList>
+                        </if>
+                    </elseActionList>
+                </if>
+            </actionList>
+        </if>
+        <if>
+            <conditionRuleList>
+                <platformTest type="osx"/>
+            </conditionRuleList>
+            <actionList>
+                <setInstallerVariable name="keyshot_deps_platform" value="macos"/>
+                <setInstallerVariable name="mac_keyshot_scripts_folder" value="${platform_install_prefix}/Application Support/KeyShot12/Scripts"/>
+                <if>
+                    <conditionRuleList>
+                        <fileExists path="${mac_keyshot_scripts_folder}" />
+                    </conditionRuleList>
+                    <actionList>
+                        <setInstallerVariable name="keyshot_scripts_folder" value="${mac_keyshot_scripts_folder}"/>
+                    </actionList>
+                    <elseActionList>
+                        <setInstallerVariable name="keyshot_scripts_folder" value="${keyshot_installdir}" />
+                        <showWarning text="No installation of KeyShot 12 was found. Please manually move the DeadlineCloudSubmitter.py script into the KeyShot scripts folder to use the plug-in." />
+                    </elseActionList>
+                </if>
+            </actionList>
+        </if>
+    </readyToInstallActionList>
+    <parameterList>
+        <stringParameter name="deadline_cloud_for_keyshot_summary" ask="0" cliOptionShow="0">
+            <value>Deadline Cloud for KeyShot
+- Install the integrated KeyShot submitter files to the installation directory
+- Register the plug-in with KeyShot by moving the DeadlineCloudSubmitter script to the KeyShot scripts folder
+- Sets the DEADLINE_KEYSHOT environment variable to point the DeadlineCloudSubmitter script to the submitter module
+            </value>
+        </stringParameter>
+    </parameterList>
+    <postInstallationActionList>
+        <unzip>
+            <destinationDirectory>${keyshot_installdir}</destinationDirectory>
+            <zipFile>${installdir}/tmp/keyshot_deps/dependency_bundle/deadline_cloud_for_keyshot_submitter-deps-${keyshot_deps_platform}.zip</zipFile>
+        </unzip>
+        <deleteFile>
+            <path>${installdir}/tmp/keyshot_deps</path>
+        </deleteFile>
+        <fnAddEnvironmentVariable>
+            <name>DEADLINE_KEYSHOT</name>
+            <value>${keyshot_installdir}/keyshot_submitter</value>
+            <scope>${installscope}</scope>
+        </fnAddEnvironmentVariable>
+    </postInstallationActionList>
+    <shouldPackRuleList>
+        <compareText>
+               <logic>does_not_contain</logic>
+               <text>${platform_name}</text>
+               <value>linux</value>
+        </compareText>
+    </shouldPackRuleList>
+</component>

keyshot_script/DealineCloudSubmitter.py → keyshot_script/DeadlineCloudSubmitter.py

@@ -18,6 +18,16 @@
 # In dev mode: src/deadline/keyshot_submitter
 DEADLINE_KEYSHOT = os.getenv("DEADLINE_KEYSHOT")
 
+if not DEADLINE_PYTHON:
+    raise RuntimeError(
+        "Environment variable DEADLINE_PYTHON not set. Please set DEADLINE_PYTHON to point to an installed version of Python with Pyside2."
+    )
+
+if not DEADLINE_KEYSHOT:
+    raise RuntimeError(
+        "Environment variable DEADLINE_KEYSHOT not set. Please set DEADLINE_KEYSHOT to point to the keyshot_submitter folder."
+    )
+
 # save scene information to json file for submitter module to load
 scene_info = lux.getSceneInfo()
 opts = lux.getRenderOptions()

scripts/_project.py

@@ -0,0 +1,82 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+from __future__ import annotations
+
+import subprocess
+import sys
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from typing import Any, Optional
+
+
+ADAPTOR_ONLY_DEPENDENCIES = {"openjd-adaptor-runtime"}
+
+
+def get_project_dict(project_path: Optional[Path] = None) -> dict[str, Any]:
+    if sys.version_info < (3, 11):
+        with TemporaryDirectory() as toml_env:
+            toml_install_pip_args = ["pip", "install", "--target", toml_env, "toml"]
+            subprocess.run(toml_install_pip_args, check=True)
+            sys.path.insert(0, toml_env)
+            import toml
+        mode = "r"
+    else:
+        import tomllib as toml
+
+        mode = "rb"
+
+    with open(str((project_path or get_git_root()) / "pyproject.toml"), mode) as pyproject_toml:
+        return toml.load(pyproject_toml)
+
+
+class Dependency:
+    name: str
+    operator: Optional[str]
+    version: Optional[str]
+
+    def __init__(self, dep: str):
+        components = dep.split(" ")
+        self.name = components[0]
+        if len(components) > 2:
+            self.operator = components[1]
+            self.version = components[2]
+        else:
+            self.operator = None
+            self.version = None
+
+    def for_pip(self) -> str:
+        if self.operator is not None and self.version is not None:
+            return f"{self.name}{self.operator}{self.version}"
+        return self.name
+
+    def __repr__(self) -> str:
+        return self.for_pip()
+
+
+def get_dependencies(pyproject_dict: dict[str, Any], exclude_adaptor_only=True) -> list[Dependency]:
+    if "project" not in pyproject_dict:
+        raise Exception("pyproject.toml is missing project section")
+    if "dependencies" not in pyproject_dict["project"]:
+        raise Exception("pyproject.toml is missing dependencies section")
+
+    return [
+        Dependency(dep_str)
+        for dep_str in pyproject_dict["project"]["dependencies"]
+        if exclude_adaptor_only or dep_str not in ADAPTOR_ONLY_DEPENDENCIES
+    ]
+
+
+def get_git_root() -> Path:
+    return Path(__file__).parents[1].resolve()
+
+
+def get_pip_platform(system_platform: str) -> str:
+    if system_platform == "Windows":
+        return "win_amd64"
+    elif system_platform == "Darwin":
+        return "macosx_10_9_x86_64"
+    elif system_platform == "Linux":
+        return "manylinux2014_x86_64"
+    else:
+        raise Exception(f"Unsupported platform: {system_platform}")