[email protected] (#3)

- fix exit code capture and message - always auth with hub license client
buildalon · Aug 11, 2024 · 5ff5b2a · 5ff5b2a
1 parent 5f92211
commit 5ff5b2a
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 143 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -28668,9 +28668,10 @@ async function Deactivate() {
             const activeLicenses = await licensingClient.ShowEntitlements();
             if (license !== undefined &&
                 !activeLicenses.includes(license.toLowerCase())) {
-                core.warning(`${license} was never activated.`);
+                throw Error(`Unity ${license} License is not activated!`);
+            } else {
+                await licensingClient.ReturnLicense(license);
             }
-            await licensingClient.ReturnLicense(license);
         }
         finally {
             core.endGroup();
@@ -28700,69 +28701,24 @@ let client = undefined;
 
 async function getLicensingClient() {
     core.debug('Getting Licensing Client...');
-    let useLicenseClient = false;
-    const editorPath = process.env.UNITY_EDITOR_PATH;
-    if (editorPath) {
-        core.debug(`Unity Editor Path: ${editorPath}`);
-        await fs.access(editorPath, fs.constants.X_OK);
-        const version = process.env.UNITY_EDITOR_VERSION || editorPath.match(/(\d+\.\d+\.\d+[a-z]?\d?)/)[0];
-        core.debug(`Unity Version: ${version}`);
-        const major = version.split('.')[0];
-        // if 2019.3 or older, use unity hub licensing client
-        useLicenseClient = major < 2020;
+    const unityHubPath = process.env.UNITY_HUB_PATH || process.env.HOME;
+    core.debug(`Unity Hub Path: ${unityHubPath}`);
+    await fs.access(unityHubPath, fs.constants.R_OK);
+    // C:\Program Files\Unity Hub\UnityLicensingClient_V1
+    // /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub/UnityLicensingClient_V1
+    // ~/Applications/Unity\ Hub.AppImage/UnityLicensingClient_V1
+    const rootHubPath = await GetHubRootPath(unityHubPath);
+    const globs = [rootHubPath, '**'];
+    if (process.platform === 'win32') {
+        globs.push('Unity.Licensing.Client.exe');
     } else {
-        useLicenseClient = true;
-    }
-    let licenseClientPath;
-    if (useLicenseClient) {
-        const unityHubPath = process.env.UNITY_HUB_PATH || process.env.HOME;
-        core.debug(`Unity Hub Path: ${unityHubPath}`);
-        await fs.access(unityHubPath, fs.constants.R_OK);
-        // C:\Program Files\Unity Hub\UnityLicensingClient_V1
-        // /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub/UnityLicensingClient_V1
-        // ~/Applications/Unity\ Hub.AppImage/UnityLicensingClient_V1
-        const rootHubPath = await GetHubRootPath(unityHubPath);
-        const globs = [rootHubPath, '**'];
-        if (process.platform === 'win32') {
-            globs.push('Unity.Licensing.Client.exe');
-        } else {
-            globs.push('Unity.Licensing.Client');
-        }
-        licenseClientPath = await ResolveGlobPath(globs);
-        core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
-        await fs.access(licenseClientPath, fs.constants.X_OK);
-        return licenseClientPath;
+        globs.push('Unity.Licensing.Client');
     }
-    else {
-        // Windows: <UnityEditorDir>\Data\Resources\Licensing\Client
-        // macOS (Editor versions 2021.3.19f1 or later): <UnityEditorDir>/Contents/Frameworks/UnityLicensingClient.app/Contents/MacOS/
-        // macOS (Editor versions earlier than 2021.3.19f1): <UnityEditorDir>/Contents/Frameworks/UnityLicensingClient.app/Contents/Resources/
-        // Linux: <UnityEditorDir>/Data/Resources/Licensing/Client/
-        const rootEditorPath = await GetEditorRootPath(editorPath);
-        core.debug(`Root Editor Path: ${rootEditorPath}`);
-        const globs = [rootEditorPath];
-        switch (process.platform) {
-            case 'win32':
-                globs.push('Data\\Resources\\Licensing\\Client\\Unity.Licensing.Client.exe');
-                break;
-            case 'darwin':
-                globs.push('Contents', 'Frameworks', 'UnityLicensingClient.app', '**', 'Unity.Licensing.Client');
-                break;
-            case 'linux':
-                globs.push('Data', 'Resources', 'Licensing', 'Client', 'Unity.Licensing.Client');
-        }
-        try {
-            licenseClientPath = path.resolve(...globs);
-            core.debug(`Testing Unity Licensing Client Path: ${licenseClientPath}`);
-            await fs.access(licenseClientPath, fs.constants.R_OK);
-        } catch (error) {
-            licenseClientPath = await ResolveGlobPath(globs);
-        }
-        core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
-        await fs.access(licenseClientPath, fs.constants.X_OK);
-        return licenseClientPath;
-    }
-};
+    const licenseClientPath = await ResolveGlobPath(globs);
+    core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
+    await fs.access(licenseClientPath, fs.constants.X_OK);
+    return licenseClientPath;
+}
 
 async function execWithMask(args) {
     if (!client) {
@@ -28774,15 +28730,16 @@ async function execWithMask(args) {
     try {
         core.info(`[command]"${client}" ${args.join(' ')}`);
         exitCode = await exec.exec(`"${client}"`, args, {
-            silent: true,
             listeners: {
                 stdout: (data) => {
                     output += data.toString();
                 },
                 stderr: (data) => {
                     output += data.toString();
                 }
-            }
+            },
+            silent: true,
+            ignoreReturnCode: true
         });
     } finally {
         const maskedOutput = maskSerialInOutput(output);
@@ -28796,15 +28753,15 @@ async function execWithMask(args) {
         }
     }
     return output;
-};
+}
 
 function maskSerialInOutput(output) {
     return output.replace(/([\w-]+-XXXX)/g, (_, serial) => {
         const maskedSerial = serial.slice(0, -4) + `XXXX`;
         core.setSecret(maskedSerial);
         return serial;
     });
-};
+}
 
 function getExitCodeMessage(exitCode) {
     switch (exitCode) {
@@ -28861,7 +28818,7 @@ const servicesPath = {
     win32: path.join(process.env.PROGRAMDATA || '', 'Unity', 'config'),
     darwin: path.join('/Library', 'Application Support', 'Unity', 'config'),
     linux: path.join('/usr', 'share', 'unity3d', 'config')
-};
+}
 
 async function Version() {
     await execWithMask([`--version`]);
@@ -28918,7 +28875,7 @@ async function ReturnLicense(license) {
     }
 }
 
-module.exports = { Version, ShowEntitlements, ActivateLicense, ActivateLicenseWithConfig, ReturnLicense };
+module.exports = { Version, ShowEntitlements, ActivateLicense, ActivateLicenseWithConfig, ReturnLicense }
 
 
 /***/ }),
@@ -28986,7 +28943,7 @@ async function findGlobPattern(pattern) {
     }
 }
 
-module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath }
+module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath };
 
 
 /***/ }),

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "activate-unity-license",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A GitHub Action to activate a Unity Game Engine license for CI/CD workflows.",
   "author": "buildalon",
   "license": "MIT",

diff --git a/src/deactivate.js b/src/deactivate.js
@@ -16,9 +16,10 @@ async function Deactivate() {
             const activeLicenses = await licensingClient.ShowEntitlements();
             if (license !== undefined &&
                 !activeLicenses.includes(license.toLowerCase())) {
-                core.warning(`${license} was never activated.`);
+                throw Error(`Unity ${license} License is not activated!`);
+            } else {
+                await licensingClient.ReturnLicense(license);
             }
-            await licensingClient.ReturnLicense(license);
         }
         finally {
             core.endGroup();

diff --git a/src/licensing-client.js b/src/licensing-client.js
@@ -8,68 +8,24 @@ let client = undefined;
 
 async function getLicensingClient() {
     core.debug('Getting Licensing Client...');
-    let useLicenseClient = false;
-    const editorPath = process.env.UNITY_EDITOR_PATH;
-    if (editorPath) {
-        core.debug(`Unity Editor Path: ${editorPath}`);
-        await fs.access(editorPath, fs.constants.X_OK);
-        const version = process.env.UNITY_EDITOR_VERSION || editorPath.match(/(\d+\.\d+\.\d+[a-z]?\d?)/)[0];
-        core.debug(`Unity Version: ${version}`);
-        const major = version.split('.')[0];
-        useLicenseClient = major < 2020;
+    const unityHubPath = process.env.UNITY_HUB_PATH || process.env.HOME;
+    core.debug(`Unity Hub Path: ${unityHubPath}`);
+    await fs.access(unityHubPath, fs.constants.R_OK);
+    // C:\Program Files\Unity Hub\UnityLicensingClient_V1
+    // /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub/UnityLicensingClient_V1
+    // ~/Applications/Unity\ Hub.AppImage/UnityLicensingClient_V1
+    const rootHubPath = await GetHubRootPath(unityHubPath);
+    const globs = [rootHubPath, '**'];
+    if (process.platform === 'win32') {
+        globs.push('Unity.Licensing.Client.exe');
     } else {
-        useLicenseClient = true;
+        globs.push('Unity.Licensing.Client');
     }
-    let licenseClientPath;
-    if (useLicenseClient) {
-        const unityHubPath = process.env.UNITY_HUB_PATH || process.env.HOME;
-        core.debug(`Unity Hub Path: ${unityHubPath}`);
-        await fs.access(unityHubPath, fs.constants.R_OK);
-        // C:\Program Files\Unity Hub\UnityLicensingClient_V1
-        // /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub/UnityLicensingClient_V1
-        // ~/Applications/Unity\ Hub.AppImage/UnityLicensingClient_V1
-        const rootHubPath = await GetHubRootPath(unityHubPath);
-        const globs = [rootHubPath, '**'];
-        if (process.platform === 'win32') {
-            globs.push('Unity.Licensing.Client.exe');
-        } else {
-            globs.push('Unity.Licensing.Client');
-        }
-        licenseClientPath = await ResolveGlobPath(globs);
-        core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
-        await fs.access(licenseClientPath, fs.constants.X_OK);
-        return licenseClientPath;
-    }
-    else {
-        // Windows: <UnityEditorDir>\Data\Resources\Licensing\Client
-        // macOS (Editor versions 2021.3.19f1 or later): <UnityEditorDir>/Contents/Frameworks/UnityLicensingClient.app/Contents/MacOS/
-        // macOS (Editor versions earlier than 2021.3.19f1): <UnityEditorDir>/Contents/Frameworks/UnityLicensingClient.app/Contents/Resources/
-        // Linux: <UnityEditorDir>/Data/Resources/Licensing/Client/
-        const rootEditorPath = await GetEditorRootPath(editorPath);
-        core.debug(`Root Editor Path: ${rootEditorPath}`);
-        const globs = [rootEditorPath];
-        switch (process.platform) {
-            case 'win32':
-                globs.push('Data\\Resources\\Licensing\\Client\\Unity.Licensing.Client.exe');
-                break;
-            case 'darwin':
-                globs.push('Contents', 'Frameworks', 'UnityLicensingClient.app', '**', 'Unity.Licensing.Client');
-                break;
-            case 'linux':
-                globs.push('Data', 'Resources', 'Licensing', 'Client', 'Unity.Licensing.Client');
-        }
-        try {
-            licenseClientPath = path.resolve(...globs);
-            core.debug(`Testing Unity Licensing Client Path: ${licenseClientPath}`);
-            await fs.access(licenseClientPath, fs.constants.R_OK);
-        } catch (error) {
-            licenseClientPath = await ResolveGlobPath(globs);
-        }
-        core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
-        await fs.access(licenseClientPath, fs.constants.X_OK);
-        return licenseClientPath;
-    }
-};
+    const licenseClientPath = await ResolveGlobPath(globs);
+    core.debug(`Unity Licensing Client Path: ${licenseClientPath}`);
+    await fs.access(licenseClientPath, fs.constants.X_OK);
+    return licenseClientPath;
+}
 
 async function execWithMask(args) {
     if (!client) {
@@ -81,15 +37,16 @@ async function execWithMask(args) {
     try {
         core.info(`[command]"${client}" ${args.join(' ')}`);
         exitCode = await exec.exec(`"${client}"`, args, {
-            silent: true,
             listeners: {
                 stdout: (data) => {
                     output += data.toString();
                 },
                 stderr: (data) => {
                     output += data.toString();
                 }
-            }
+            },
+            silent: true,
+            ignoreReturnCode: true
         });
     } finally {
         const maskedOutput = maskSerialInOutput(output);
@@ -103,15 +60,15 @@ async function execWithMask(args) {
         }
     }
     return output;
-};
+}
 
 function maskSerialInOutput(output) {
     return output.replace(/([\w-]+-XXXX)/g, (_, serial) => {
         const maskedSerial = serial.slice(0, -4) + `XXXX`;
         core.setSecret(maskedSerial);
         return serial;
     });
-};
+}
 
 function getExitCodeMessage(exitCode) {
     switch (exitCode) {
@@ -168,7 +125,7 @@ const servicesPath = {
     win32: path.join(process.env.PROGRAMDATA || '', 'Unity', 'config'),
     darwin: path.join('/Library', 'Application Support', 'Unity', 'config'),
     linux: path.join('/usr', 'share', 'unity3d', 'config')
-};
+}
 
 async function Version() {
     await execWithMask([`--version`]);
@@ -225,4 +182,4 @@ async function ReturnLicense(license) {
     }
 }
 
-module.exports = { Version, ShowEntitlements, ActivateLicense, ActivateLicenseWithConfig, ReturnLicense };
+module.exports = { Version, ShowEntitlements, ActivateLicense, ActivateLicenseWithConfig, ReturnLicense }
diff --git a/src/utility.js b/src/utility.js
@@ -58,4 +58,4 @@ async function findGlobPattern(pattern) {
     }
 }
 
-module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath }
+module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath };
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,4 +58,4 @@ async function findGlobPattern(pattern) { @@
         }
     }
-    module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath }
+    module.exports = { ResolveGlobPath, GetEditorRootPath, GetHubRootPath };