test: Run integration tests across Cinema 4D versions (2024,2025,2026)

Signed-off-by: Karthik Bekal Pattathana <133984042+karthikbekalp@users.noreply.github.com>

Author: karthikbekalp

.github/workflows/integ_macos.yml

@@ -2,6 +2,11 @@ name: "Integ Tests - macOS"
 
 on:
   workflow_call:
+    inputs:
+      c4d_version:
+        description: Cinema 4D major version to test
+        required: true
+        type: string
     secrets:
       AWS_OIDC_ROLE_ARN:
         required: true
@@ -22,8 +27,9 @@ jobs:
   IntegMacOS:
     if: >-
       github.repository == 'aws-deadline/deadline-cloud-for-cinema-4d' &&
-      github.ref == 'refs/heads/mainline'
-    name: Integration Tests (macOS)
+      (github.ref == 'refs/heads/mainline' ||
+      github.ref == 'refs/heads/feature/ci-tests')
+    name: Integration Tests (macOS, Cinema 4D ${{ inputs.c4d_version }})
     runs-on: macos-latest
     timeout-minutes: 60
     permissions:
@@ -35,7 +41,7 @@ jobs:
       redshift_LICENSE: "${{ secrets.RLM_PORT }}@127.0.0.1"
       g_licenseServerRLM: "127.0.0.1:${{ secrets.RLM_PORT }}"
       g_licenseModel: "LICENSEMODEL::RLM"
-      C4D_VERSION: "2026"
+      C4D_VERSION: ${{ inputs.c4d_version }}
       INSTALLER_BUCKET: ${{ secrets.INSTALLER_BUCKET }}
       INSTALLER_BUCKET_EXPECTED_OWNER: ${{ secrets.INSTALLER_BUCKET_EXPECTED_OWNER }}
     steps:
@@ -82,8 +88,8 @@ jobs:
 
       - name: Grant accessibility to Cinema 4D
         run: |
-          C4D_BIN="/Applications/Maxon Cinema 4D 2026/Cinema 4D.app/Contents/MacOS/Cinema 4D"
-          C4DPY_BIN="/Applications/Maxon Cinema 4D 2026/c4dpy.app/Contents/MacOS/c4dpy"
+          C4D_BIN="/Applications/Maxon Cinema 4D $C4D_VERSION/Cinema 4D.app/Contents/MacOS/Cinema 4D"
+          C4DPY_BIN="/Applications/Maxon Cinema 4D $C4D_VERSION/c4dpy.app/Contents/MacOS/c4dpy"
           for BIN_PATH in "$C4D_BIN" "$C4DPY_BIN"; do
             if [ -f "$BIN_PATH" ]; then
               sudo sqlite3 "/Library/Application Support/com.apple.TCC/TCC.db" \

.github/workflows/integ_windows.yml

@@ -2,6 +2,11 @@ name: "Integ Tests - Windows"
 
 on:
   workflow_call:
+    inputs:
+      c4d_version:
+        description: Cinema 4D major version to test
+        required: true
+        type: string
     secrets:
       AWS_OIDC_ROLE_ARN:
         required: true
@@ -22,8 +27,9 @@ jobs:
   IntegWindows:
     if: >-
       github.repository == 'aws-deadline/deadline-cloud-for-cinema-4d' &&
-      github.ref == 'refs/heads/mainline'
-    name: Integration Tests (Windows)
+      (github.ref == 'refs/heads/mainline' ||
+      github.ref == 'refs/heads/feature/ci-tests')
+    name: Integration Tests (Windows, Cinema 4D ${{ inputs.c4d_version }})
     runs-on: windows-latest
     timeout-minutes: 60
     permissions:
@@ -35,7 +41,7 @@ jobs:
       redshift_LICENSE: "${{ secrets.RLM_PORT }}@127.0.0.1"
       g_licenseServerRLM: "127.0.0.1:${{ secrets.RLM_PORT }}"
       g_licenseModel: "LICENSEMODEL::RLM"
-      C4D_VERSION: "2026"
+      C4D_VERSION: ${{ inputs.c4d_version }}
       INSTALLER_BUCKET: ${{ secrets.INSTALLER_BUCKET }}
       INSTALLER_BUCKET_EXPECTED_OWNER: ${{ secrets.INSTALLER_BUCKET_EXPECTED_OWNER }}
     steps:
@@ -135,6 +141,15 @@ jobs:
 
           hatch run integ:test
 
+      - name: Upload render outputs
+        if: always()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: cinema4d-${{ inputs.c4d_version }}-render-outputs
+          path: test/integ/test_cases/**/actual/renders/**
+          if-no-files-found: ignore
+          retention-days: 7
+
       - name: Tear down
         if: always()
         shell: pwsh

.github/workflows/integration_tests_xa11y.yml

@@ -4,10 +4,18 @@ on:
   push:
     branches:
       - mainline
+      - feature/ci-tests
 
 jobs:
   windows:
+    name: Windows, Cinema 4D ${{ matrix.c4d_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        c4d_version: ["2024", "2025", "2026"]
     uses: ./.github/workflows/integ_windows.yml
+    with:
+      c4d_version: ${{ matrix.c4d_version }}
     secrets:
       AWS_OIDC_ROLE_ARN: ${{ secrets.AWS_OIDC_ROLE_ARN }}
       AWS_REGION: ${{ secrets.AWS_REGION }}
@@ -21,7 +29,14 @@ jobs:
       contents: read
 
   macos:
+    name: macOS, Cinema 4D ${{ matrix.c4d_version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        c4d_version: ["2024", "2025", "2026"]
     uses: ./.github/workflows/integ_macos.yml
+    with:
+      c4d_version: ${{ matrix.c4d_version }}
     secrets:
       AWS_OIDC_ROLE_ARN: ${{ secrets.AWS_OIDC_ROLE_ARN }}
       AWS_REGION: ${{ secrets.AWS_REGION }}

pipeline/setup-runner.py

@@ -14,11 +14,23 @@
 from botocore.config import Config
 
 C4D_INSTALLERS = {
+    "2024": {
+        "windows": {
+            "s3_key": "cinema4d/2024/Cinema4D_2024_2024.5.1_Win.exe",
+            "sha256": "e71f7f103bb783fc5155e1b43e057d20c839052a0fe712ea3f42e447acff46b1",
+            "type": "exe",
+        },
+        "macos": {
+            "s3_key": "cinema4d/2024/Cinema4D_2024_2024.5.1_Mac.dmg",
+            "sha256": "08d3d0efc8dd06f69fae8f86bf50539689b12029a2ac79c0d6c358f7d9d63edc",
+            "type": "dmg",
+        },
+    },
     "2025": {
         "windows": {
-            "s3_key": "cinema4d/2025/Cinema4D_2025_2025.3.3_Win.zip",
-            "sha256": "fcf0ea40af73727f1bc1fb1a47ea0c2f3476f0652824d3b740181dc1a6123e09",
-            "type": "zip",
+            "s3_key": "cinema4d/2025/Cinema4D_2025_2025.3.3_Win.exe",
+            "sha256": "66f5f5b74f93b32490d32386c642d6857aef98629a5b3eaa88fa366b1598a18e",
+            "type": "exe",
         },
         "macos": {
             "s3_key": "cinema4d/2025/Cinema4D_2025_2025.3.3_Mac.dmg",
@@ -41,6 +53,10 @@
 }
 
 C4D_INSTALL_PATHS = {
+    "2024": {
+        "windows": Path("C:/Program Files/Maxon Cinema 4D 2024"),
+        "macos": Path("/Applications/Maxon Cinema 4D 2024"),
+    },
     "2025": {
         "windows": Path("C:/Program Files/Maxon Cinema 4D 2025"),
         "macos": Path("/Applications/Maxon Cinema 4D 2025"),
@@ -182,17 +198,17 @@ def setup_windows(versions):
 def setup_macos(versions):
     """Install Cinema 4D on macOS for each version."""
     for version in versions:
+        if "macos" not in C4D_INSTALLERS.get(version, {}):
+            print(f"ERROR: No macOS installer configured for version {version}")
+            sys.exit(1)
+
         install_dir = C4D_INSTALL_PATHS[version]["macos"]
         marker = install_dir / ".installed"
 
         if marker.exists():
             print(f"Cinema 4D {version} already installed at {install_dir}")
             continue
 
-        if "macos" not in C4D_INSTALLERS.get(version, {}):
-            print(f"ERROR: No macOS installer configured for version {version}")
-            sys.exit(1)
-
         print(f"Installing Cinema 4D {version}...")
         installer_info = C4D_INSTALLERS[version]["macos"]
         local_installer = Path(f"/tmp/{Path(installer_info['s3_key']).name}")
@@ -333,7 +349,7 @@ def _configure_rlm_licensing(versions, platform_key):
         "--versions",
         nargs="+",
         required=True,
-        help="Cinema 4D versions to install (e.g., 2025 2026)",
+        help="Cinema 4D versions to install (e.g., 2024 2025 2026)",
     )
     args = parser.parse_args()
 

skills/c4d-dev/references/integration-testing.md

@@ -26,10 +26,12 @@ purpose of this suite is to cover the customer-visible plugin and UI path.
 - Run Windows tests in an interactive desktop session; UI Automation does not
   work in Session 0.
 - Configure renderer licensing for renderer-specific cases.
-- Set `C4D_LOCATION` when Cinema 4D is outside a known default path.
+- Local runs default to Cinema 4D 2026. Set `C4D_VERSION` to run an older
+  version, and set `C4D_LOCATION` when that version is outside its default path.
 
 ```powershell
-$env:C4D_LOCATION = "C:\Program Files\Maxon Cinema 4D 2026\"
+$env:C4D_VERSION = "2025"
+$env:C4D_LOCATION = "D:\Applications\Maxon Cinema 4D 2025\"
 $env:redshift_LICENSE = "<port>@<license-server>"
 ```
 
@@ -48,6 +50,7 @@ test/integ/test_cases/<case>/
 └── expected/
     ├── job_bundle/
     └── renders/
+        └── <C4D_VERSION>/
 ```
 
 Use a dedicated parametrized test when one scene and configurator intentionally
@@ -128,13 +131,29 @@ After the missing-golden failure leaves output in `actual/`:
    ignores it.
 5. Serialize all three documents as block YAML.
 6. On Windows, copy the reviewed files from `actual/renders/` into the matching
-   `expected/renders/` directory.
+   `expected/renders/<C4D_VERSION>/` directory.
 
 Use structured YAML operations rather than text substitutions. Review every
 golden diff before accepting it; generated output is not automatically correct.
 
 Never commit `actual/`.
 
+## Capture Render Outputs in CI
+
+When local Windows rendering is not practical:
+
+1. Push the changes to the repository's `feature/ci-tests` branch.
+2. Wait for the **Cinema 4D xa11y Integration Tests** workflow to finish.
+3. Download the `cinema4d-<C4D_VERSION>-render-outputs` artifact from the run.
+4. Review the extracted `<case>/actual/renders/` images.
+5. Copy approved PNGs into the matching
+   `expected/renders/<C4D_VERSION>/` directory, or the corresponding
+   `expected/<variant>/renders/<C4D_VERSION>/` directory.
+
+Only retained `actual/` files are uploaded. Successful cases clean that
+directory, while missing or mismatched goldens leave output available for
+download. Never commit the extracted `actual/` directories.
+
 ## Verify
 
 Run focused checks first, then the full applicable suite:

src/deadline/cinema4d_adaptor/Cinema4DClient/plugin/DeadlineCloudClient.pyp

@@ -8,6 +8,17 @@ print('system paths:')
 for n in sys.path:
     print(n)
 
+_adaptor_testing = os.environ.get("CINEMA4D_ADAPTOR_TESTING", "false").lower() == "true"
+
+# Integration tests inject pywin32 from a Hatch environment without Conda activation.
+# Keep this handle alive so win32file can load pywintypes311.dll in that test environment.
+_dll_directory_handles = []
+if sys.platform == "win32" and _adaptor_testing:
+    for python_path in sys.path:
+        pywin32_dll_directory = os.path.join(python_path, "pywin32_system32")
+        if os.path.isdir(pywin32_dll_directory):
+            _dll_directory_handles.append(os.add_dll_directory(pywin32_dll_directory))
+
 import c4d
 
 # The Cinema4D Adaptor adds the `deadline` namespace directory to PYTHONPATH,
@@ -33,5 +44,5 @@ def PluginMessage(id, data):
 # TODO: Investigate if this file is still needed. 
 # Currently, PluginMessage function is not called when the plugin is loaded in adaptor tests.
 # To unblock for tests, we check if the environment variable is set and if so, run the main function.
-if os.environ.get("CINEMA4D_ADAPTOR_TESTING", "false").lower() == "true":
-    main()
+if _adaptor_testing:
+    main()

test/AGENTS.md

@@ -118,7 +118,8 @@ test_cases/<name>/
 │                          #              before Export (runs in pytest + xa11y)
 ├── expected/              # what we compare against
 │   ├── job_bundle/        #   golden template/parameter_values/asset_references
-│   └── renders/           #   golden render PNGs (Windows-only compare)
+│   └── renders/           #   version-specific golden PNGs (Windows-only compare)
+│       └── <C4D_VERSION>/ #   required baseline for each tested C4D version
 └── actual/                # gitignored — runtime output; kept on failure
 ```
 
@@ -134,7 +135,29 @@ need per-farm regeneration.
 `input/scene.py` runs inside **c4dpy** (Cinema 4D's headless Python) and is saved
 into `actual/` (not `input/`), so render paths under `renders/` resolve into
 `actual/renders/`. Cases may override the output filename, but keep this
-directory stable for render comparison.
+directory stable for render comparison. Render comparison requires a baseline
+under `expected/renders/<C4D_VERSION>/`. Failed Windows CI cases
+retain their generated images and upload them in the
+`cinema4d-<version>-render-outputs` workflow artifact for seven days.
+
+#### Downloading render outputs from CI
+
+Use the versioned Windows CI jobs when render goldens cannot be generated
+locally:
+
+1. Push the changes to the `feature/ci-tests` branch in this repository.
+2. Wait for the **Cinema 4D xa11y Integration Tests** workflow to finish.
+3. Open the workflow run and download the
+   `cinema4d-<C4D_VERSION>-render-outputs` artifact for each required version.
+4. Extract the artifact and review every PNG under
+   `<case>/actual/renders/`.
+5. Copy approved images into
+   `test/integ/test_cases/<case>/expected/renders/<C4D_VERSION>/`, or
+   `expected/<variant>/renders/<C4D_VERSION>/` for a parametrized case.
+
+The artifact step always runs, but successful cases remove their `actual/`
+directory before upload. Missing or mismatched goldens leave render output
+behind for collection. Never commit the extracted `actual/` directories.
 
 #### Focused settings coverage
 
@@ -252,6 +275,11 @@ production.
 hatch run integ:test                              # all xa11y integ tests
 ```
 
+CI runs this suite against Cinema 4D 2024, 2025, and 2026 on Windows and
+macOS. All six jobs run in parallel. Local runs default to Cinema 4D 2026.
+Set `C4D_VERSION` for an older version and set `C4D_LOCATION` only when its
+installation is outside that version's default path.
+
 The `integ:test` script hardcodes the `test/integ` path and
 `--numprocesses=1`. Beware: any args you pass *replace* the path (hatch
 `{args:test/integ}` falls back to the global `testpaths = ["test"]`), so