fix(submitter): read includeAllLights setting correctly

[jericht]

Fixes: #206

What was the problem/requirement? (What/Why)

The IncludeAllLights by default setting for render layers is not being captured correctly by the submitter. The current implementation queries if the corresponding optionVar is set, however if it is not set, then it treats the value as false, even if the actual check box is checked. This value is fed into the RenderSetupIncludeLights job parameter which is used by the adaptor to enable/disable the feature for all render layers. This causes confusion when renders submitted to Deadline Cloud return images with incorrect lighting that cannot be reproduced locally since the option is checked locally but not in Deadline Cloud.

What was the solution? (How)

Revert the logic for populating the RenderSetupIncludeLights job parameter to the original implementation

What is the impact of this change?

The RenderSetupIncludeLights job parameter reflects the current state of the corresponding option

How was this change tested?

• Ran unit tests
• Manually tested in Maya. Verified that a scene file that has the option checked but has the corresponding option var unset generates a job bundle with RenderSetupIncludeLights set to true.

Did you run the "Job Bundle Output Tests"? If not, why not? If so, paste the test results here.

Timestamp: 2025-01-07T17:37:26.535028-08:00
Running job bundle output test: /Users/jericht/Repositories/deadline-cloud-for-maya/job_bundle_output_tests/layers

layers
Test succeeded

Timestamp: 2025-01-07T17:37:27.595248-08:00
Running job bundle output test: /Users/jericht/Repositories/deadline-cloud-for-maya/job_bundle_output_tests/referenced_layers

referenced_layers
Test succeeded

Timestamp: 2025-01-07T17:37:28.054335-08:00
Running job bundle output test: /Users/jericht/Repositories/deadline-cloud-for-maya/job_bundle_output_tests/renderman
Skipping test renderman because Renderman for Maya is not installed.
Timestamp: 2025-01-07T17:37:28.054420-08:00
Running job bundle output test: /Users/jericht/Repositories/deadline-cloud-for-maya/job_bundle_output_tests/cube

cube
Test succeeded

Timestamp: 2025-01-07T17:37:28.588416-08:00
Running job bundle output test: /Users/jericht/Repositories/deadline-cloud-for-maya/job_bundle_output_tests/layers_no_variation

layers_no_variation
Test succeeded

All tests passed, ran 4 total.
Timestamp: 2025-01-07T17:37:31.931839-08:00

Was this change documented?

N/A

Is this a breaking change?

No

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[leongdl]

thank you.

[epmog]

Because this is a per-machine setting, we should be updating our job bundle output test infrastructure to ensure we can have a test so we don't regress on this. Will require us to change how we set that value on the test machines as we basically want to control this at the test level.

https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/src/deadline/maya_submitter/job_bundle_output_test_runner.py#L34-L49

[jericht]

Because this is a per-machine setting, we should be updating our job bundle output test infrastructure to ensure we can have a test so we don't regress on this. Will require us to change how we set that value on the test machines as we basically want to control this at the test level.

https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/src/deadline/maya_submitter/job_bundle_output_test_runner.py#L34-L49

Sounds good, I'll do this in a follow-up PR! #208