|
| 1 | +### What was the problem/requirement? (What/Why) |
| 2 | + |
| 3 | +The Windows integration workflow exposed two startup failure modes: |
| 4 | + |
| 5 | +1. Cinema 4D 2025 encountered a rare native startup crash and exited with |
| 6 | + `0xC0000005` (`STATUS_ACCESS_VIOLATION`) before its submitter accessibility |
| 7 | + application appeared. The test continued waiting for UI Automation, which |
| 8 | + obscured the native process failure. |
| 9 | +2. A later run never opened the local SSM license-forwarding port. The workflow |
| 10 | + did not retain the AWS CLI process or capture its stderr, so it could only |
| 11 | + report a port timeout. `Test-NetConnection` also made the nominal timeout |
| 12 | + substantially longer than the message indicated. |
| 13 | + |
| 14 | +Failed jobs: |
| 15 | + |
| 16 | +- Cinema 4D startup crash: |
| 17 | + https://github.com/aws-deadline/deadline-cloud-for-cinema-4d/actions/runs/31621623631/job/94197613785 |
| 18 | +- SSM port-forward startup failure: |
| 19 | + https://github.com/aws-deadline/deadline-cloud-for-cinema-4d/actions/runs/31669886824/job/94352428414 |
| 20 | + |
| 21 | +### What was the solution? (How) |
| 22 | + |
| 23 | +The Windows integration test now monitors the launched Cinema 4D process before |
| 24 | +each UI Automation scan: |
| 25 | + |
| 26 | +- If the accessibility application appears, the test continues normally. |
| 27 | +- If Cinema 4D exits first, the test reports its decimal and hexadecimal exit |
| 28 | + codes and restarts Cinema 4D once. |
| 29 | +- The failed process is cleaned up before the second launch. |
| 30 | +- Each attempt logs its PID and has a separate plugin diagnostic log. |
| 31 | +- A warning records the first startup failure even when the second launch |
| 32 | + succeeds. |
| 33 | +- If the second launch also exits early, the test fails with the native exit |
| 34 | + code. |
| 35 | + |
| 36 | +Only an early process exit is retried. Accessibility timeouts and failures after |
| 37 | +startup are not retried. |
| 38 | + |
| 39 | +The integration tests now run in-process with uncaptured output so Cinema 4D |
| 40 | +and xa11y progress is visible immediately. If a test runs for ten minutes, |
| 41 | +pytest's faulthandler dumps every Python thread and exits rather than waiting |
| 42 | +for the GitHub Actions job timeout. |
| 43 | + |
| 44 | +The Windows SSM setup now: |
| 45 | + |
| 46 | +- Retains the `aws ssm start-session` process and reports an early exit code. |
| 47 | +- Uses a direct TCP connection to check the local listener six times at |
| 48 | + five-second intervals. |
| 49 | +- If the first session does not open the port, cleans up the partial process and |
| 50 | + session, waits five seconds, and starts one fresh SSM session. |
| 51 | +- After both attempts fail, reports whether the AWS CLI exited without printing |
| 52 | + raw SSM logs. |
| 53 | +- Captures the SSM session ID for deterministic teardown. |
| 54 | + |
| 55 | +### What is the impact of this change? |
| 56 | + |
| 57 | +This change only affects the integration test harness and Windows integration |
| 58 | +workflow. It makes the suite resilient to a rare, transient Cinema 4D startup |
| 59 | +crash, retries a failed SSM tunnel once, and reports whether the AWS CLI exited |
| 60 | +if both tunnel attempts fail. |
| 61 | + |
| 62 | +There is no change to the Cinema 4D submitter, adaptor, customer workflows, or |
| 63 | +production behavior. |
| 64 | + |
| 65 | +### How was this change tested? |
| 66 | + |
| 67 | +- Unit tests: `358 passed, 6 skipped` |
| 68 | +- `hatch run lint`: passed |
| 69 | +- Workflow YAML parsing: passed |
| 70 | +- `git diff --check`: passed |
| 71 | + |
| 72 | +- Have you run the unit tests? |
| 73 | + |
| 74 | + Yes. `hatch run test` completed with `358 passed, 6 skipped`. |
| 75 | + |
| 76 | +- Have you run the integration tests? (Add your integration test report below) |
| 77 | + |
| 78 | + Not locally. The full integration suite requires a Windows environment with |
| 79 | + Cinema 4D installed, GitHub OIDC credentials, and access to the license |
| 80 | + infrastructure. End-to-end validation must run in the versioned Windows |
| 81 | + integration workflow. |
| 82 | + |
| 83 | +- Have you made changes to the submitter? |
| 84 | + |
| 85 | + No. The changes are limited to the integration test harness, its Hatch |
| 86 | + command, the Windows workflow, and test documentation. |
| 87 | + |
| 88 | +### Was this change documented? |
| 89 | + |
| 90 | +The modified integration-test functions include updated docstrings, and |
| 91 | +`test/AGENTS.md` documents the in-process execution and hang diagnostics. No |
| 92 | +README, schema, or customer-facing documentation changes are required. |
| 93 | + |
| 94 | +### Is this a breaking change? |
| 95 | + |
| 96 | +No. This change is limited to integration test behavior and does not modify any |
| 97 | +public contract or customer-facing functionality. |
| 98 | + |
| 99 | +---- |
| 100 | + |
| 101 | +*By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.* |
0 commit comments