Support Multiple License Products when using Unity Licensing Server

[ejnarvala]

Changes

This change enables supporting unity floating license servers with multiple products configured, more info here.

• adds an action parameter unityLicensingProductIds
• updates services-config.json.template to set toolset based on unityLicensingProductIds. If this value is set to an empty string, it will use the server's default configuration, the same behavior as if the parameter was not included at alll

Related PRs

• https://github.com/game-ci/unity-test-runner/pull/282

Related Issues

• https://github.com/game-ci/unity-test-runner/issues/283

Successful Workflow Run Link

PRs don't have access to secrets so you will need to provide a link to a successful run of the workflows from your own repo.

• Our repositories are private, but we have successfully run a workflow using this fork.

Checklist

• [x] Read the contribution guide and accept the code of conduct
• [x] Docs (If new inputs or outputs have been added or changes to behavior that should be documented. Please make a PR in the documentation repo)
  • https://github.com/game-ci/documentation/pull/472
• [x] Readme (updated or not needed)
• [x] Tests (added, updated or not needed)

Summary by CodeRabbit

• New Features

  • Introduced an optional input parameter for Unity licensing product IDs to enhance license management.
  • Added a new environment variable for Unity licensing product IDs to improve configurability.

• Bug Fixes

  • Maintained existing error handling and control flow across various components, ensuring stability.

• Documentation

  • Updated method signatures and descriptions to reflect the addition of the new licensing parameter.

[github-actions[bot]]

[GabLeRoux]

@coderabbitai do a full review

[coderabbitai[bot]]

@GabLeRoux: Understood, I will perform a full review of the PR.

:white_check_mark: Actions performed

Full review triggered.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

:no_entry: Files ignored due to path filters (2)

• dist/index.js is excluded by !**/dist/**
• dist/index.js.map is excluded by !**/dist/**, !**/*.map

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a new input parameter, unityLicensingProductIds, across several files related to the Unity test runner. This parameter is optional and allows users to specify a comma-separated list of license product identifiers for the Unity licensing server. The modifications affect how input parameters are handled, how the Docker container is configured, and how environment variables are set up, without altering the overall structure or logic of existing functionalities.

Changes

File Path	Change Summary
action.yml	Added new optional input parameter unityLicensingProductIds with a default value of an empty string.
src/main.ts	Introduced unityLicensingProductIds to the input parameters in the run function and passed it to Docker.run.
src/model/docker.ts	Updated run method signature to include parameters.unityLicensingProductIds in the call to LicensingServerSetup.Setup.
src/model/image-environment-factory.ts	Added new environment variable UNITY_LICENSING_PRODUCT_IDS in getEnvironmentVariables method.
src/model/input.ts	Added new input variable unityLicensingProductIds in getFromUser method, initialized from user input.
src/model/licensing-server-setup.ts	Updated Setup method signature to include unityLicensingProductIds and replace placeholder in servicesConfig.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Input
    participant Docker
    participant LicensingServerSetup
    participant ImageEnvironmentFactory

    User->>Input: Provide unityLicensingProductIds
    Input->>Docker: Pass unityLicensingProductIds
    Docker->>LicensingServerSetup: Setup with unityLicensingProductIds
    LicensingServerSetup->>ImageEnvironmentFactory: Configure environment with UNITY_LICENSING_PRODUCT_IDS

🐇 "In the meadow, changes sprout,
New licenses to talk about!
With product IDs in tow,
Unity's magic starts to flow.
A hop, a skip, a joyful cheer,
For all the bunnies, it's finally here!" 🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.