Feature/add support for licensing server (#196)

* First take on adding support for sending in unity licensing server url on linux * Forgot to build dist * Moved services-config parsing to typescript * Need to set licensing server env variable for activate.sh * Forgot unused docker mount directory /resources
game-ci · Nov 4, 2022 · 9fe2feb · 9fe2feb
1 parent 68d1df1
commit 9fe2feb
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 7 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/steps/activate.sh b/dist/steps/activate.sh
@@ -77,7 +77,21 @@ elif [[ -n "$UNITY_SERIAL" && -n "$UNITY_EMAIL" && -n "$UNITY_PASSWORD" ]]; then
 
   # Store the exit code from the verify command
   UNITY_EXIT_CODE=$?
+elif [[ -n "$UNITY_LICENSING_SERVER" ]]; then
+  #
+  # Custom Unity License Server
+  #
+  echo "Adding licensing server config"
 
+  /opt/unity/Editor/Data/Resources/Licensing/Client/Unity.Licensing.Client --acquire-floating > license.txt #is this accessible in a env variable?
+  UNITY_EXIT_CODE=$?
+  PARSEDFILE=$(grep -oP '\".*?\"' < license.txt | tr -d '"')
+  export FLOATING_LICENSE
+  FLOATING_LICENSE=$(sed -n 2p <<< "$PARSEDFILE")
+  FLOATING_LICENSE_TIMEOUT=$(sed -n 4p <<< "$PARSEDFILE")
+
+  echo "Acquired floating license: \"$FLOATING_LICENSE\" with timeout $FLOATING_LICENSE_TIMEOUT"
+  # Store the exit code from the verify command
 else
   #
   # NO LICENSE ACTIVATION STRATEGY MATCHED

diff --git a/dist/steps/return_license.sh b/dist/steps/return_license.sh
@@ -4,7 +4,13 @@
 echo "Changing to \"$ACTIVATE_LICENSE_PATH\" directory."
 pushd "$ACTIVATE_LICENSE_PATH"
 
-if [[ -n "$UNITY_SERIAL" ]]; then
+if [[ -n "$UNITY_LICENSING_SERVER" ]]; then  #
+  #
+  # Return any floating license used.
+  #
+  echo "Returning floating license: \"$FLOATING_LICENSE\""
+  /opt/unity/Editor/Data/Resources/Licensing/Client/Unity.Licensing.Client --return-floating "$FLOATING_LICENSE"
+elif [[ -n "$UNITY_SERIAL" ]]; then
   #
   # PROFESSIONAL (SERIAL) LICENSE MODE
   #
@@ -17,6 +23,5 @@ if [[ -n "$UNITY_SERIAL" ]]; then
     -quit \
     -returnlicense
 fi
-
 # Return to previous working directory
 popd
diff --git a/dist/unity-config/services-config.json.template b/dist/unity-config/services-config.json.template
@@ -0,0 +1,7 @@
+{
+  "licensingServiceBaseUrl": "%URL%",
+  "enableEntitlementLicensing": true,
+  "enableFloatingApi": true,
+  "clientConnectTimeoutSec": 5,
+  "clientHandshakeTimeoutSec": 10
+}
diff --git a/src/main.ts b/src/main.ts
@@ -20,6 +20,7 @@ export async function run() {
       githubToken,
       checkName,
       chownFilesTo,
+      unityLicensingServer,
     } = Input.getFromUser();
     const baseImage = new ImageTag({ editorVersion, customImage });
     const runnerContext = Action.runnerContext();
@@ -39,6 +40,7 @@ export async function run() {
         gitPrivateToken,
         githubToken,
         chownFilesTo,
+        unityLicensingServer,
         ...runnerContext,
       });
     } finally {

diff --git a/src/model/docker.ts b/src/model/docker.ts
@@ -1,4 +1,5 @@
 import { existsSync, mkdirSync, readFileSync, rmSync } from 'fs';
+import LicensingServerSetup from './licensing-server-setup';
 import type { RunnerContext } from './action';
 import { exec } from '@actions/exec';
 import path from 'path';
@@ -30,6 +31,11 @@ const Docker = {
 
   async run(image, parameters, silent = false) {
     let runCommand = '';
+
+    if (parameters.unityLicensingServer !== '') {
+      LicensingServerSetup.Setup(parameters.unityLicensingServer, parameters.actionFolder);
+    }
+
     switch (process.platform) {
       case 'linux':
         runCommand = this.getLinuxCommand(image, parameters);
@@ -60,6 +66,7 @@ const Docker = {
       githubToken,
       runnerTemporaryPath,
       chownFilesTo,
+      unityLicensingServer,
     } = parameters;
 
     const githubHome = path.join(runnerTemporaryPath, '_github_home');
@@ -80,6 +87,7 @@ const Docker = {
                 --env UNITY_EMAIL \
                 --env UNITY_PASSWORD \
                 --env UNITY_SERIAL \
+                --env UNITY_LICENSING_SERVER="${unityLicensingServer}" \
                 --env UNITY_VERSION="${editorVersion}" \
                 --env PROJECT_PATH="${projectPath}" \
                 --env CUSTOM_PARAMETERS="${customParameters}" \
@@ -110,6 +118,7 @@ const Docker = {
                 --volume "${workspace}:/github/workspace:z" \
                 --volume "${actionFolder}/steps:/steps:z" \
                 --volume "${actionFolder}/entrypoint.sh:/entrypoint.sh:z" \
+                --volume "${actionFolder}/unity-config:/usr/share/unity3d/config/:z" \
                 ${sshAgent ? `--volume ${sshAgent}:/ssh-agent` : ''} \
                 ${
                   sshAgent ? `--volume /home/runner/.ssh/known_hosts:/root/.ssh/known_hosts:ro` : ''
@@ -136,6 +145,7 @@ const Docker = {
       githubToken,
       runnerTemporaryPath,
       chownFilesTo,
+      unityLicensingServer,
     } = parameters;
 
     const githubHome = path.join(runnerTemporaryPath, '_github_home');
@@ -156,6 +166,7 @@ const Docker = {
                 --env UNITY_EMAIL \
                 --env UNITY_PASSWORD \
                 --env UNITY_SERIAL \
+                --env UNITY_LICENSING_SERVER="${unityLicensingServer}" \
                 --env UNITY_VERSION="${editorVersion}" \
                 --env PROJECT_PATH="${projectPath}" \
                 --env CUSTOM_PARAMETERS="${customParameters}" \

diff --git a/src/model/input.ts b/src/model/input.ts
@@ -17,6 +17,7 @@ const Input = {
     const unityVersion = getInput('unityVersion') || 'auto';
     const customImage = getInput('customImage') || '';
     const rawProjectPath = getInput('projectPath') || '.';
+    const unityLicensingServer = getInput('unityLicensingServer') || '';
     const customParameters = getInput('customParameters') || '';
     const testMode = (getInput('testMode') || 'all').toLowerCase();
     const coverageOptions = getInput('coverageOptions') || '';
@@ -67,6 +68,7 @@ const Input = {
       githubToken,
       checkName,
       chownFilesTo,
+      unityLicensingServer,
     };
   },
 };

diff --git a/src/model/licensing-server-setup.ts b/src/model/licensing-server-setup.ts
@@ -0,0 +1,20 @@
+import * as core from '@actions/core';
+import fs from 'fs';
+
+class LicensingServerSetup {
+  public static Setup(unityLicensingServer, actionFolder: string) {
+    const servicesConfigPath = `${actionFolder}/unity-config/services-config.json`;
+    const servicesConfigPathTemplate = `${servicesConfigPath}.template`;
+    if (!fs.existsSync(servicesConfigPathTemplate)) {
+      core.error(`Missing services config ${servicesConfigPathTemplate}`);
+
+      return;
+    }
+
+    let servicesConfig = fs.readFileSync(servicesConfigPathTemplate).toString();
+    servicesConfig = servicesConfig.replace('%URL%', unityLicensingServer);
+    fs.writeFileSync(servicesConfigPath, servicesConfig);
+  }
+}
+
+export default LicensingServerSetup;