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

.github/FUNDING.yml

@@ -1,8 +1,8 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: game-ci
 patreon: # Replace with a single Patreon username
-open_collective: game-ci
+open_collective: # replace with a single OpenCollective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

action.yml

@@ -61,5 +61,6 @@ branding:
   icon: 'box'
   color: 'gray-dark'
 runs:
-  using: 'node12'
-  main: 'dist/index.js'
+  using: 'node16'
+  main: 'dist/main.js'
+  post: 'dist/post.js'

dist/licenses.txt

@@ -686,6 +686,19 @@ Permission to use, copy, modify, and/or distribute this software for any purpose
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
 webidl-conversions
 BSD-2-Clause
 # The BSD 2-Clause License

dist/main.js

@@ -0,0 +1 @@
+index.js

dist/post.js

@@ -0,0 +1 @@
+index.js

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

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

dist/unity-config/services-config.json.template

@@ -0,0 +1,7 @@
+{
+  "licensingServiceBaseUrl": "%URL%",
+  "enableEntitlementLicensing": true,
+  "enableFloatingApi": true,
+  "clientConnectTimeoutSec": 5,
+  "clientHandshakeTimeoutSec": 10
+}

package.json

@@ -8,14 +8,14 @@
   "license": "MIT",
   "scripts": {
     "prebuild": "yarn",
-    "build": "tsc && ncc build lib --source-map --license licenses.txt",
-    "lint": "prettier --check \"src/**/*.{js,ts}\" && eslint src/**/*.ts",
+    "build": "tsc && ncc build lib/index.js --source-map --license licenses.txt",
+    "lint": "prettier --check \"src/**/*.{js,ts}\" && eslint src --ext .js,.ts --max-warnings=0",
     "format": "prettier --write \"src/**/*.{js,ts}\"",
     "test": "jest",
     "prepare": "husky install"
   },
   "dependencies": {
-    "@actions/core": "^1.6.0",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.0",
     "@actions/github": "^5.0.0",
     "@octokit/openapi-types": "^11.2.0",

src/index.ts

@@ -1,60 +1,30 @@
-import * as core from '@actions/core';
-import { Action, Docker, ImageTag, Input, Output, ResultsCheck } from './model';
+import { run as main } from './main';
+import path from 'path';
+import { run as post } from './post';
 
-async function run() {
-  try {
-    Action.checkCompatibility();
+/*
+ * GitHub Action can provide multiple executable entrypoints (pre, main, post),
+ * but it is complicated process to generate multiple `.js` files with `ncc`.
+ * So we rather generate just one entrypoint, that is symlinked to multiple locations (main.js and post.js).
+ * Then when GitHub Action Runner executes it as `node path/to/main.js` and `node path/to/post.js`,
+ * it can read arguments it was executed with and decide which file to execute.
+ * The argv[0] is going to be a full path to `node` executable and
+ * the argv[1] is going to be the full path to the script.
+ * In case index.js would be marked executable and executed directly without the argv[1] it defaults to "main.js".
+ */
+async function run([, name = 'main.js']: string[]) {
+  const script = path.basename(name);
 
-    const { workspace, actionFolder } = Action;
-    const {
-      editorVersion,
-      customImage,
-      projectPath,
-      customParameters,
-      testMode,
-      coverageOptions,
-      artifactsPath,
-      useHostNetwork,
-      sshAgent,
-      gitPrivateToken,
-      githubToken,
-      checkName,
-      chownFilesTo,
-    } = Input.getFromUser();
-    const baseImage = new ImageTag({ editorVersion, customImage });
-    const runnerTemporaryPath = process.env.RUNNER_TEMP;
-
-    try {
-      await Docker.run(baseImage, {
-        actionFolder,
-        editorVersion,
-        workspace,
-        projectPath,
-        customParameters,
-        testMode,
-        coverageOptions,
-        artifactsPath,
-        useHostNetwork,
-        sshAgent,
-        gitPrivateToken,
-        githubToken,
-        runnerTemporaryPath,
-        chownFilesTo,
-      });
-    } finally {
-      await Output.setArtifactsPath(artifactsPath);
-      await Output.setCoveragePath('CodeCoverage');
-    }
-
-    if (githubToken) {
-      const failedTestCount = await ResultsCheck.createCheck(artifactsPath, githubToken, checkName);
-      if (failedTestCount >= 1) {
-        core.setFailed(`Test(s) Failed! Check '${checkName}' for details.`);
-      }
-    }
-  } catch (error: any) {
-    core.setFailed(error.message);
+  switch (script) {
+    case 'main.js':
+      await main();
+      break;
+    case 'post.js':
+      await post();
+      break;
+    default:
+      throw new Error(`Unknown script argument: '${script}'`);
   }
 }
 
-run();
+run(process.argv);

src/main.ts

@@ -0,0 +1,60 @@
+import * as core from '@actions/core';
+import { Action, Docker, ImageTag, Input, Output, ResultsCheck } from './model';
+
+export async function run() {
+  try {
+    Action.checkCompatibility();
+
+    const { workspace, actionFolder } = Action;
+    const {
+      editorVersion,
+      customImage,
+      projectPath,
+      customParameters,
+      testMode,
+      coverageOptions,
+      artifactsPath,
+      useHostNetwork,
+      sshAgent,
+      gitPrivateToken,
+      githubToken,
+      checkName,
+      chownFilesTo,
+      unityLicensingServer,
+    } = Input.getFromUser();
+    const baseImage = new ImageTag({ editorVersion, customImage });
+    const runnerContext = Action.runnerContext();
+
+    try {
+      await Docker.run(baseImage, {
+        actionFolder,
+        editorVersion,
+        workspace,
+        projectPath,
+        customParameters,
+        testMode,
+        coverageOptions,
+        artifactsPath,
+        useHostNetwork,
+        sshAgent,
+        gitPrivateToken,
+        githubToken,
+        chownFilesTo,
+        unityLicensingServer,
+        ...runnerContext,
+      });
+    } finally {
+      await Output.setArtifactsPath(artifactsPath);
+      await Output.setCoveragePath('CodeCoverage');
+    }
+
+    if (githubToken) {
+      const failedTestCount = await ResultsCheck.createCheck(artifactsPath, githubToken, checkName);
+      if (failedTestCount >= 1) {
+        core.setFailed(`Test(s) Failed! Check '${checkName}' for details.`);
+      }
+    }
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

src/model/action.ts

@@ -1,5 +1,10 @@
 import path from 'path';
 
+export interface RunnerContext {
+  runnerTemporaryPath: string;
+  githubAction: string;
+}
+
 const Action = {
   get supportedPlatforms() {
     return ['linux', 'win32'];
@@ -33,6 +38,16 @@ const Action = {
     return process.env.GITHUB_WORKSPACE;
   },
 
+  runnerContext(): RunnerContext {
+    const runnerTemporaryPath = process.env.RUNNER_TEMP ?? process.cwd();
+    const githubAction = process.env.GITHUB_ACTION ?? process.pid.toString();
+
+    return {
+      runnerTemporaryPath,
+      githubAction,
+    };
+  },
+
   checkCompatibility() {
     const currentPlatform = process.platform;
     if (!Action.supportedPlatforms.includes(currentPlatform)) {

src/model/docker.ts

@@ -1,10 +1,41 @@
-import { existsSync, mkdirSync } from 'fs';
+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';
 
+/**
+ * Build a path for a docker --cidfile parameter. Docker will store the the created container.
+ * This path is stable for the whole execution of the action, so it can be executed with the same parameters
+ * multiple times and get the same result.
+ */
+const containerIdFilePath = parameters => {
+  const { runnerTemporaryPath, githubAction } = parameters;
+
+  return path.join(runnerTemporaryPath, `container_${githubAction}`);
+};
+
 const Docker = {
+  /**
+   *  Remove a possible leftover container created by `Docker.run`.
+   */
+  async ensureContainerRemoval(parameters: RunnerContext) {
+    const cidfile = containerIdFilePath(parameters);
+    if (!existsSync(cidfile)) {
+      return;
+    }
+    const container = readFileSync(cidfile, 'ascii').trim();
+    await exec(`docker`, ['rm', '--force', '--volumes', container], { silent: true });
+    rmSync(cidfile);
+  },
+
   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);
@@ -15,6 +46,7 @@ const Docker = {
       default:
         throw new Error(`Operation system, ${process.platform}, is not supported yet.`);
     }
+
     await exec(runCommand, undefined, { silent });
   },
 
@@ -34,24 +66,28 @@ const Docker = {
       githubToken,
       runnerTemporaryPath,
       chownFilesTo,
+      unityLicensingServer,
     } = parameters;
 
     const githubHome = path.join(runnerTemporaryPath, '_github_home');
     if (!existsSync(githubHome)) mkdirSync(githubHome);
     const githubWorkflow = path.join(runnerTemporaryPath, '_github_workflow');
     if (!existsSync(githubWorkflow)) mkdirSync(githubWorkflow);
+    const cidfile = containerIdFilePath(parameters);
     const testPlatforms = (
       testMode === 'all' ? ['playmode', 'editmode', 'COMBINE_RESULTS'] : [testMode]
     ).join(';');
 
     return `docker run \
                 --workdir /github/workspace \
+                --cidfile "${cidfile}" \
                 --rm \
                 --env UNITY_LICENSE \
                 --env UNITY_LICENSE_FILE \
                 --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}" \
@@ -82,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` : ''
@@ -108,10 +145,12 @@ const Docker = {
       githubToken,
       runnerTemporaryPath,
       chownFilesTo,
+      unityLicensingServer,
     } = parameters;
 
     const githubHome = path.join(runnerTemporaryPath, '_github_home');
     if (!existsSync(githubHome)) mkdirSync(githubHome);
+    const cidfile = containerIdFilePath(parameters);
     const githubWorkflow = path.join(runnerTemporaryPath, '_github_workflow');
     if (!existsSync(githubWorkflow)) mkdirSync(githubWorkflow);
     const testPlatforms = (
@@ -120,12 +159,14 @@ const Docker = {
 
     return `docker run \
                 --workdir /github/workspace \
+                --cidfile "${cidfile}" \
                 --rm \
                 --env UNITY_LICENSE \
                 --env UNITY_LICENSE_FILE \
                 --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}" \

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,
     };
   },
 };

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;

src/post.ts

@@ -0,0 +1,12 @@
+import * as core from '@actions/core';
+import Action from './model/action';
+import { Docker } from './model';
+
+export async function run() {
+  try {
+    const parameters = Action.runnerContext();
+    await Docker.ensureContainerRemoval(parameters);
+  } catch (error: any) {
+    core.setFailed(error.message);
+  }
+}

yarn.lock

@@ -2,12 +2,13 @@
 # yarn lockfile v1
 
 
-"@actions/core@^1.6.0":
-  version "1.6.0"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.6.0.tgz#0568e47039bfb6a9170393a73f3b7eb3b22462cb"
-  integrity sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==
+"@actions/core@^1.10.0":
+  version "1.10.0"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.10.0.tgz#44551c3c71163949a2f06e94d9ca2157a0cfac4f"
+  integrity sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==
   dependencies:
-    "@actions/http-client" "^1.0.11"
+    "@actions/http-client" "^2.0.1"
+    uuid "^8.3.2"
 
 "@actions/exec@^1.1.0":
   version "1.1.0"
@@ -33,6 +34,13 @@
   dependencies:
     tunnel "0.0.6"
 
+"@actions/http-client@^2.0.1":
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-2.0.1.tgz#873f4ca98fe32f6839462a6f046332677322f99c"
+  integrity sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==
+  dependencies:
+    tunnel "^0.0.6"
+
 "@actions/io@^1.0.1":
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/@actions/io/-/io-1.1.1.tgz#4a157406309e212ab27ed3ae30e8c1d641686a66"
@@ -4746,7 +4754,7 @@ tsutils@^3.21.0:
   dependencies:
     tslib "^1.8.1"
 
-tunnel@0.0.6:
+tunnel@0.0.6, tunnel@^0.0.6:
   version "0.0.6"
   resolved "https://registry.yarnpkg.com/tunnel/-/tunnel-0.0.6.tgz#72f1314b34a5b192db012324df2cc587ca47f92c"
   integrity sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==
@@ -4862,7 +4870,7 @@ use@^3.1.0:
   resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f"
   integrity sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==
 
-uuid@^8.3.0:
+uuid@^8.3.0, uuid@^8.3.2:
   version "8.3.2"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
   integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==