Skip to content

Commit 7be7fcc

Browse files
vrtxLeonievrtxLeonie
authored
Correcting UnitySetupTask postjobexecution repetition (#292)
* Move input variables to own script on UnitySetup When using the UnitySetup task, I noticed that the post-job always tries to reinstall unity again, even though it should just check for the license deactivation, as the unity-setup.post script instructs. The cause seems to be that the unity-editor-deactivation script imports variables from the main unity-setup script, which in turn runs that whole script again. While this did not impede any functions, it was an additional 2 minutes of time the agent spent checking the Unity installation, instead of just logging out. Moving all variables to a seperate file with no function call fixed the issue for me. * Implementing installEditor bool While checking for the post-job repetition issue, I noticed that the installEditor bool is not actually used anywhere, and added it to the install scripts. * Moved deactivateSeatOnComplete bool Sometimes a pipeline would throw an error during the post-job due to "getProjectUnityVersion()" failing for example, even though deactivationOnComplete was turned off anyway and the project version was not needed. Checking the bool right at the beginning of the script avoids unneccessary work. * Fixed typo :)
1 parent 9aa683b commit 7be7fcc

File tree

9 files changed

+67
-52
lines changed

9 files changed

+67
-52
lines changed

‎Tasks/UnitySetup/UnitySetupV2/task.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
},
2727
{
2828
"name": "unityInstallation",
29-
"displayName": "Unity Installation / Configuraiton",
29+
"displayName": "Unity Installation / Configuration",
3030
"isExpanded": true
3131
},
3232
{

‎Tasks/UnitySetup/UnitySetupV2/unity-editor-activation.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import tl = require('azure-pipelines-task-lib/task');
2-
import { usernameInputVariableName, passwordInputVariableName, serialInputVariableName, activateLicenseInputVariableName } from './unity-setup';
2+
import { usernameInputVariableName, passwordInputVariableName, serialInputVariableName, activateLicenseInputVariableName } from './variables';
33
import { getProjectUnityVersion } from './utilities';
44
import path = require('path');
55
import { UnityPathTools, Utilities } from '@dinomite-studios/unity-azure-pipelines-tasks-lib';

‎Tasks/UnitySetup/UnitySetupV2/unity-editor-configuration.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnityPathTools, UnityPackageManagerTools } from '@dinomite-studios/unity-azure-pipelines-tasks-lib';
22
import tl = require('azure-pipelines-task-lib/task');
33
import path = require('path');
4-
import { androidChildModulesInputVariableName, androidConfigureToolingInputVariableName, androidModuleInputVariableName } from './unity-setup';
4+
import { androidChildModulesInputVariableName, androidConfigureToolingInputVariableName, androidModuleInputVariableName } from './variables';
55
import { getProjectUnityVersion } from './utilities';
66

77
export class UnityEditorConfiguration {

‎Tasks/UnitySetup/UnitySetupV2/unity-editor-deactivation.ts‎

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import tl = require('azure-pipelines-task-lib/task');
2-
import { usernameInputVariableName, passwordInputVariableName, serialInputVariableName, deactivateSeatOnCompleteInputVariableName, activateLicenseInputVariableName } from './unity-setup';
2+
import { usernameInputVariableName, passwordInputVariableName, serialInputVariableName, deactivateSeatOnCompleteInputVariableName, activateLicenseInputVariableName } from './variables';
33
import { getProjectUnityVersion } from './utilities';
44
import path = require('path');
55
import { UnityPathTools, Utilities } from '@dinomite-studios/unity-azure-pipelines-tasks-lib';
@@ -11,6 +11,11 @@ export class UnityEditorDeactivation {
1111
return 0;
1212
}
1313

14+
const deactivateSeatOnComplete = tl.getBoolInput(deactivateSeatOnCompleteInputVariableName);
15+
if (!deactivateSeatOnComplete) {
16+
return 0;
17+
}
18+
1419
const editorVersion = getProjectUnityVersion();
1520
const editorInstallationsPath = UnityPathTools.getUnityEditorsPath('default');
1621
const unityExecutablePath = UnityPathTools.getUnityExecutableFullPath(editorInstallationsPath, editorVersion!);
@@ -19,25 +24,23 @@ export class UnityEditorDeactivation {
1924
const password = tl.getInput(passwordInputVariableName, true)!;
2025

2126
const logFilesDirectory = path.join(tl.getVariable('Agent.TempDirectory')!, 'Logs');
22-
const logFilePath = path.join(logFilesDirectory, `UnityDeactivationLog_${Utilities.getLogFileNameTimeStamp()}.log`);
23-
const deactivateSeatOnComplete = tl.getBoolInput(deactivateSeatOnCompleteInputVariableName);
24-
25-
if (deactivateSeatOnComplete) {
26-
const unityCmd = tl.tool(unityExecutablePath)
27-
.arg('-batchmode')
28-
.arg('-nographics')
29-
.arg('-username').arg(username)
30-
.arg('-password').arg(password)
31-
.arg('-returnlicense')
32-
.arg('-logfile').arg(logFilePath)
33-
.arg('-quit');
34-
35-
const result = unityCmd.execSync();
36-
37-
if (result.code !== 0) {
38-
return result.code;
39-
}
40-
}
27+
const logFilePath = path.join(logFilesDirectory, `UnityDeactivationLog_${Utilities.getLogFileNameTimeStamp()}.log`);
28+
29+
30+
const unityCmd = tl.tool(unityExecutablePath)
31+
.arg('-batchmode')
32+
.arg('-nographics')
33+
.arg('-username').arg(username)
34+
.arg('-password').arg(password)
35+
.arg('-returnlicense')
36+
.arg('-logfile').arg(logFilePath)
37+
.arg('-quit');
38+
39+
const result = unityCmd.execSync();
40+
41+
if (result.code !== 0) {
42+
return result.code;
43+
}
4144

4245
return 0;
4346
}

‎Tasks/UnitySetup/UnitySetupV2/unity-editor-install.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@ import tl = require('azure-pipelines-task-lib/task');
22
import path = require('path');
33
import { OS, Utilities } from '@dinomite-studios/unity-azure-pipelines-tasks-lib/';
44
import { getProjectUnityVersion, getUnityHubExecutablePath } from './utilities';
5-
import { macOSArchitectureVariableName } from './unity-setup';
5+
import { macOSArchitectureVariableName, installEditorInputVariableName } from './variables';
66

77
export class UnityEditorInstall {
88
public static run(): number {
9+
const installEditor = tl.getBoolInput(installEditorInputVariableName);
10+
if (!installEditor) {
11+
return 0;
12+
}
13+
914
const unityHubExecutablePath = getUnityHubExecutablePath();
1015
const editorVersion = getProjectUnityVersion();
1116

‎Tasks/UnitySetup/UnitySetupV2/unity-modules-install.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
import { androidChildModulesInputVariableName, androidModuleInputVariableName, iOSModuleInputVariableName, linuxIL2CPPModuleInputVariableName, linuxMonoModuleInputVariableName, macIL2CPPModuleInputVariableName, macMonoModuleInputVariableName, tvOSModuleInputVariableName, uwpModuleInputVariableName, visionOSModuleInputVariableName, webGLModuleInputVariableName, windowsModuleInputVariableName } from "./unity-setup";
1+
import { installEditorInputVariableName, androidChildModulesInputVariableName, androidModuleInputVariableName, iOSModuleInputVariableName, linuxIL2CPPModuleInputVariableName, linuxMonoModuleInputVariableName, macIL2CPPModuleInputVariableName, macMonoModuleInputVariableName, tvOSModuleInputVariableName, uwpModuleInputVariableName, visionOSModuleInputVariableName, webGLModuleInputVariableName, windowsModuleInputVariableName } from "./variables";
22
import tl = require('azure-pipelines-task-lib/task');
33
import { getProjectUnityVersion, getUnityHubExecutablePath } from "./utilities";
44

55
export class UnityModulesInstall {
66

77
public static run(): number {
8+
const installEditor = tl.getBoolInput(installEditorInputVariableName);
9+
if (!installEditor) {
10+
return 0;
11+
}
12+
813
const unityHubExecutablePath = getUnityHubExecutablePath();
914
const editorVersion = getProjectUnityVersion();
1015

‎Tasks/UnitySetup/UnitySetupV2/unity-setup.ts‎

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,6 @@ import { UnityModulesInstall } from './unity-modules-install';
55
// import { UnityEditorConfiguration } from './unity-editor-configuration';
66
import { UnityEditorActivation } from './unity-editor-activation';
77

8-
// Input variables
9-
export const versionSelectionModeVariableName = "versionSelectionMode";
10-
export const versionInputVariableName = 'version';
11-
export const revisionInputVariableName = 'revision';
12-
export const activateLicenseInputVariableName = 'activateLicense';
13-
export const usernameInputVariableName = 'username';
14-
export const passwordInputVariableName = 'password';
15-
export const serialInputVariableName = 'serial';
16-
export const deactivateSeatOnCompleteInputVariableName = 'deactivateSeatOnComplete';
17-
export const unityHubExecutableLocationVariableName = 'unityHubExecutableLocation';
18-
export const customUnityHubExecutableLocationVariableName = 'customUnityHubExecutableLocation';
19-
export const macOSArchitectureVariableName = 'macOSArchitecture';
20-
export const androidModuleInputVariableName = 'installAndroidModule';
21-
export const androidChildModulesInputVariableName = 'installAndroidChildModules';
22-
export const androidConfigureToolingInputVariableName = 'configureAndroidTooling';
23-
export const iOSModuleInputVariableName = 'installIOSModule';
24-
export const tvOSModuleInputVariableName = 'installTVOSModule';
25-
export const visionOSModuleInputVariableName = 'installVisionOSModule';
26-
export const linuxMonoModuleInputVariableName = 'installLinuxMonoModule';
27-
export const linuxIL2CPPModuleInputVariableName = 'installLinuxIL2CPPModule';
28-
export const macMonoModuleInputVariableName = 'installMacMonoModule';
29-
export const macIL2CPPModuleInputVariableName = 'installMacIL2CPPModule';
30-
export const windowsModuleInputVariableName = 'installWindowsIL2CPPModule';
31-
export const uwpModuleInputVariableName = 'installUWPModule';
32-
export const webGLModuleInputVariableName = 'installWebGLModule';
33-
348
function run() {
359
try {
3610
// Configure localization.

‎Tasks/UnitySetup/UnitySetupV2/utilities.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import tl = require('azure-pipelines-task-lib/task');
22
import { UnityPathTools, UnityVersionInfo, UnityVersionInfoResult, UnityVersionTools } from '@dinomite-studios/unity-azure-pipelines-tasks-lib/';
3-
import { customUnityHubExecutableLocationVariableName, revisionInputVariableName, unityHubExecutableLocationVariableName, versionInputVariableName, versionSelectionModeVariableName } from './unity-setup';
3+
import { customUnityHubExecutableLocationVariableName, revisionInputVariableName, unityHubExecutableLocationVariableName, versionInputVariableName, versionSelectionModeVariableName } from './variables';
44

55
export function getProjectUnityVersion(): UnityVersionInfo | null | undefined {
66
let editorVersion: UnityVersionInfo | null | undefined;

‎Tasks/UnitySetup/UnitySetupV2/variables.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import tl = require('azure-pipelines-task-lib/task');
2+
3+
// Input variables
4+
export const versionSelectionModeVariableName = "versionSelectionMode";
5+
export const versionInputVariableName = 'version';
6+
export const revisionInputVariableName = 'revision';
7+
export const activateLicenseInputVariableName = 'activateLicense';
8+
export const installEditorInputVariableName = 'installEditor';
9+
export const usernameInputVariableName = 'username';
10+
export const passwordInputVariableName = 'password';
11+
export const serialInputVariableName = 'serial';
12+
export const deactivateSeatOnCompleteInputVariableName = 'deactivateSeatOnComplete';
13+
export const unityHubExecutableLocationVariableName = 'unityHubExecutableLocation';
14+
export const customUnityHubExecutableLocationVariableName = 'customUnityHubExecutableLocation';
15+
export const macOSArchitectureVariableName = 'macOSArchitecture';
16+
export const androidModuleInputVariableName = 'installAndroidModule';
17+
export const androidChildModulesInputVariableName = 'installAndroidChildModules';
18+
export const androidConfigureToolingInputVariableName = 'configureAndroidTooling';
19+
export const iOSModuleInputVariableName = 'installIOSModule';
20+
export const tvOSModuleInputVariableName = 'installTVOSModule';
21+
export const visionOSModuleInputVariableName = 'installVisionOSModule';
22+
export const linuxMonoModuleInputVariableName = 'installLinuxMonoModule';
23+
export const linuxIL2CPPModuleInputVariableName = 'installLinuxIL2CPPModule';
24+
export const macMonoModuleInputVariableName = 'installMacMonoModule';
25+
export const macIL2CPPModuleInputVariableName = 'installMacIL2CPPModule';
26+
export const windowsModuleInputVariableName = 'installWindowsIL2CPPModule';
27+
export const uwpModuleInputVariableName = 'installUWPModule';
28+
export const webGLModuleInputVariableName = 'installWebGLModule';

0 commit comments

Comments
 (0)