feat: add virtual workstation setup scripts for Linux and Windows

tests/conftest.py

@@ -109,6 +109,25 @@ def find_host_configuration_scripts() -> list[Path]:
     return sorted(set(scripts))
 
 
+def find_utility_scripts() -> list[Path]:
+    """Shell / PowerShell scripts under ``utility_scripts/``.
+
+    These are run by an administrator on a workstation rather than uploaded to the
+    service, so the host configuration length limit does not apply to them. They
+    still get the same syntax checks, since a sample that does not parse is broken
+    for everyone who copies it.
+    """
+    base = REPO_ROOT / "utility_scripts"
+    if not base.is_dir():
+        return []
+    scripts = []
+    for pattern in ("*.sh", "*.ps1"):
+        for path in base.rglob(pattern):
+            if not _is_excluded(path.relative_to(REPO_ROOT)):
+                scripts.append(path)
+    return sorted(set(scripts))
+
+
 def find_cloudformation_templates() -> list[Path]:
     """CloudFormation templates (YAML files under ``cloudformation/``).
 

tests/test_utility_scripts.py

@@ -0,0 +1,75 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+"""Syntax checks for the standalone scripts under ``utility_scripts/``.
+
+Unlike a host configuration script, these are not uploaded to the service, so the
+``scriptBody`` length limit does not apply. What does apply is that they parse: a
+sample that does not is broken for everyone who copies it, and these run as root or
+an administrator, where a syntax error can surface halfway through an install.
+
+The same reasoning as ``test_host_configuration_scripts.py`` applies to the tools --
+``bash`` and ``pwsh`` are required, and a missing one fails rather than skips,
+because a skipped check is indistinguishable from a passing one.
+"""
+from __future__ import annotations
+
+import os
+import subprocess
+from pathlib import Path
+
+import pytest
+
+from conftest import find_utility_scripts, rel, require_tool
+
+_SCRIPTS = find_utility_scripts()
+_SHELL_SCRIPTS = [s for s in _SCRIPTS if s.suffix == ".sh"]
+_POWERSHELL_SCRIPTS = [s for s in _SCRIPTS if s.suffix == ".ps1"]
+
+
+def test_utility_scripts_discovered():
+    assert _SCRIPTS, "no utility scripts were discovered"
+
+
+@pytest.mark.parametrize("script", _SCRIPTS, ids=rel)
+def test_script_is_not_empty(script: Path):
+    assert script.read_text(encoding="utf-8", errors="replace").strip(), f"{rel(script)} is empty"
+
+
+@pytest.mark.parametrize("script", _SHELL_SCRIPTS, ids=rel)
+def test_shell_script_syntax(script: Path):
+    """`bash -n` catches syntax errors without executing anything."""
+    bash = require_tool("bash", "install bash (present by default on Linux/macOS)")
+    result = subprocess.run(
+        [bash, "-n", str(script)], capture_output=True, text=True, timeout=30
+    )
+    assert result.returncode == 0, (
+        f"bash syntax check failed for {rel(script)}:\n{result.stderr}"
+    )
+
+
+@pytest.mark.parametrize("script", _POWERSHELL_SCRIPTS, ids=rel)
+def test_powershell_script_syntax(script: Path):
+    """Parse each PowerShell script with the PowerShell parser (no execution)."""
+    pwsh = require_tool(
+        "pwsh",
+        "install PowerShell (https://learn.microsoft.com/powershell/); "
+        "pre-installed on GitHub-hosted runners",
+    )
+    # The script path goes through an environment variable rather than being
+    # interpolated into the command, so it cannot be interpreted as PowerShell.
+    ps_command = (
+        "$p = $env:PWSH_TARGET_SCRIPT; $errors = $null; "
+        "[System.Management.Automation.Language.Parser]::ParseFile("
+        "$p, [ref]$null, [ref]$errors) | Out-Null; "
+        "if ($errors) { $errors | ForEach-Object { Write-Output $_.ToString() }; exit 1 } "
+        "else { exit 0 }"
+    )
+    result = subprocess.run(
+        [pwsh, "-NoProfile", "-NonInteractive", "-Command", ps_command],
+        capture_output=True,
+        text=True,
+        timeout=60,
+        env={**os.environ, "PWSH_TARGET_SCRIPT": str(script)},
+    )
+    assert result.returncode == 0, (
+        f"PowerShell parse failed for {rel(script)}:\n{result.stdout}\n{result.stderr}"
+    )

utility_scripts/README.md

@@ -9,6 +9,7 @@ This table covers every immediate user-selectable sample directory in `utility_s
 | Sample | What it demonstrates | Start here when |
 |---|---|---|
 | [Upload to job attachments](upload_to_job_attachments/) | Uploading files into content-addressable job attachment storage with deduplication | Large or reused datasets should be staged before job submission |
+| [Virtual workstation](virtual_workstation/) | Provisioning a Linux or Windows workstation with a DCC, the Deadline Cloud submitter, and a pre-configured monitor profile | Artists should find a submission-ready machine and only need to sign in |
 
 ## Upload to job attachments
 
@@ -38,6 +39,20 @@ python upload_to_job_attachments/upload_to_job_attachments.py \
 
 See the [sample README](upload_to_job_attachments/) for installation, permissions, options, and manifest details.
 
+## Virtual workstation
+
+Example scripts for Linux and Windows prepare a workstation for Deadline Cloud submission. Each one installs Blender, then installs the Deadline Cloud submitter and monitor through their silent installers. It finishes by creating a monitor profile non-interactively, so an artist only has to sign in.
+
+```console
+# Linux, as root
+sudo virtual_workstation/setup_workstation_linux.sh https://mystudio.us-west-2.deadlinecloud.amazonaws.com/
+
+# Windows, in an elevated PowerShell session
+.\virtual_workstation\setup_workstation_windows.ps1 https://mystudio.us-west-2.deadlinecloud.amazonaws.com/
+```
+
+Blender stands in for whichever DCC you run. See the [sample README](virtual_workstation/) for prerequisites, adapting the scripts to another DCC, and cleanup.
+
 ## Additional resources
 
 * [AWS Deadline Cloud user guide](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/index.html)