Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add KeyShot 2024 support #91

Merged

Conversation

joel-wong-aws
Copy link
Contributor

@joel-wong-aws joel-wong-aws commented Jun 5, 2024

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

Add KeyShot 2024 support :)

What was the solution? (How)

The only code specific to KeyShot 2023 is in the installer. It was assuming that KeyShot installation is done as a user install to C:\Users\<USER>\Documents\KeyShot 12. However, this is not always the case. The more general solution is to use the KEYSHOT/KEYSHOT12 env vars to retrieve the location of the KeyShot install.

Note that we do not have Mac installers. Hence, I have removed the macOS installer code to avoid confusion.

What is the impact of this change?

This allows more flexibility for customers in the use of Deadline Cloud for KeyShot!

How was this change tested?

  1. End to end testing in KeyShot 2024.
  2. Ran the installer in different scenarios
  3. Ran the installer via the CLI

End to end test in KeyShot 2024

  1. Created a customer managed worker following the guide here
  2. Installed KeyShot 2024
  3. Submitted a job via KeyShot 2024
  4. Ran a worker agent, which picked up the job and successfully ran it

Running the installer

Ran the installer in three scenarios:

  1. with the KEYSHOT env var (from KeyShot 2024)
  2. with the KEYSHOT12 env var (from KeyShot 2023)
  3. without either env var

In cases 1 and 2, the scripts directory was autofilled in the installer and I just had to confirm the location.

image

In case 3, I had to manually input the location. I also verified that if the location didn't exist, the installation was rejected.

image

Ran the installer via the CLI

Ran the installer with the --mode unattended argument and used the keyshot-scripts-folder command line argument
$ DeadlineCloudSubmitter-windows-x64-installer.exe --enable-components deadline-cloud-for-keyshot --keyshot-scripts-directory C:\Users\test-user\Documents\KeyShot\Scripts --mode unattended

Help entry (DeadlineCloudSubmitter-windows-x64-installer.exe --help):
image

Was this change documented?

Yes, in the README.md

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.

@joel-wong-aws joel-wong-aws requested a review from a team as a code owner June 5, 2024 21:09
crowecawcaw
crowecawcaw previously approved these changes Jun 5, 2024
@joel-wong-aws joel-wong-aws changed the title feat: add KeyShot 2024 support wip: feat: add KeyShot 2024 support Jun 5, 2024
@joel-wong-aws joel-wong-aws force-pushed the keyshot_2024_support branch 2 times, most recently from fa93e55 to 2861c07 Compare June 6, 2024 17:13
@joel-wong-aws joel-wong-aws changed the title wip: feat: add KeyShot 2024 support feat: add KeyShot 2024 support Jun 6, 2024
@joel-wong-aws joel-wong-aws force-pushed the keyshot_2024_support branch from 2861c07 to 6382534 Compare June 6, 2024 18:40
Copy link

sonarqubecloud bot commented Jun 6, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@joel-wong-aws joel-wong-aws enabled auto-merge (squash) June 10, 2024 04:27
@joel-wong-aws joel-wong-aws merged commit d6d2dfa into aws-deadline:mainline Jun 10, 2024
10 checks passed
@joel-wong-aws joel-wong-aws deleted the keyshot_2024_support branch June 10, 2024 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants