[Bug] All custom variables are stripped from app Variables v3 to v4

[digiman57]

Prerequisites

• Ensure you write a short, descriptive title after [Bug] above.
• Make sure to search for any existing issues before filing a new one.
• Verify you are able to reproduce the issue with the latest released version

PSAppDeployToolkit.Tools version

0.2.2

PSAppDeployToolkit version

4.04

Describe the bug

Win10 VMware VM. I converted a couple v3 scripts that had string variables similar to built in variables (all listed under AppScriptAuthor) , such as [string]$MSIName1 = 'MSI_Name', etc.
The built in variables are the only variables to show up in the converted v4 script. 2nd problem, is none of these extra or custom variables in the head of the old v3 script are set to the new switch, down in the sections of the script. Ex: #MSIName1 should be converted to $adtSession.MSIName1, but the variable shows up like this, $MSIName1. My scripts can contain up to 18 custom variables (as I really only had to file data in the variables and rarely touch the script. I had if statements thoughout the different sections that used the custom variables at the head, and would even use them in the fuctions, such as $InstallTime in the line for Show-InstallationProgress. That variable is there in the line, without the new formatting, but it is also missing in the head of the script as the custom variables were stripped out.

Steps to reproduce

1. I installed the latest ADT toolkit in a powershell console and also installed the Tools modules as of 1-11-25
2. I ran Convert-ADTDeployment and converted a template v.3.10.2 script and later a full blown app script
3. The invoke-AppDeployToolkit.ps1 in each case were missing all the custom variables at the head and inside the pre, install, post, etc. sections, the custom variables were lacking the new format form.

Environment data

OsName               : Microsoft Windows 10 Enterprise
OsOperatingSystemSKU : EnterpriseEdition
OsArchitecture       : 64-bit
WindowsVersion       : 2009
WindowsProductName   : Windows 10 Enterprise
WindowsBuildLabEx    : 19041.1.amd64fre.vb_release.191206-1406
OsLanguage           : en-US
OsMuiLanguages       : {en-US}
KeyboardLayout       : en-US
TimeZone             : (UTC-06:00) Central Time (US & Canada)
HyperVisorPresent    : True
CsPartOfDomain       : False
CsPCSystemType       : Desktop


Host:
  Version:      8.0.2
  Architecture: x64
  Commit:       1381d5ebd2
  RID:          win-x64

.NET SDKs installed:
  No SDKs were found.

.NET runtimes installed:
  Microsoft.NETCore.App 5.0.8 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 6.0.6 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 7.0.0 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 8.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.NETCore.App 8.0.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
  Microsoft.WindowsDesktop.App 5.0.8 [C:\Program Files\dotnet\shared\Microsoft.Windows
Desktop.App]
  Microsoft.WindowsDesktop.App 6.0.6 [C:\Program Files\dotnet\shared\Microsoft.Windows
Desktop.App]
  Microsoft.WindowsDesktop.App 7.0.0 [C:\Program Files\dotnet\shared\Microsoft.Windows
Desktop.App]
  Microsoft.WindowsDesktop.App 8.0.2 [C:\Program Files\dotnet\shared\Microsoft.Windows
Desktop.App]

Other architectures found:
  None

Environment variables:
  Not set

global.json file:
  Not found

Learn more:
  https://aka.ms/dotnet/info

Download .NET:
  https://aka.ms/dotnet/download

[DanGough]

Currently it only converts known variables plus the code blocks within the main If statement. But I will look into adding any unknown variables outside of here also.

[digiman57]

Thanks DanGough, I work with other techs who also use added variables in the V3 Variables Declaration section at the head of the script, or V3, the APp Variables section.
These are just a bit of the added variables I have added to our templates.
[String]$appScriptAuthor = ''
[string]$MSIName1 = 'MSI_Name'
[string]$MSTName1 = 'MST_Name'
[string]$EXEName = 'Name_of_EXE-Here'
etc.
All of these variables means I can put Install time (for the dialog), Parameters for MSI, Exe, uninstall details, etc.
This lets us fill out a package doc and copy and paste into the variable section and not touch the body of the script.
Just giving you an idea how we use the variables.
If the install is an engineering install script, we may also use ADT functions to grab app installed details and create functions per the app we are dealing with, possible in all the sections of the script. All of the added or custom variables missing from the head appear unaltered in the script and converted over OK, so for now, I will make sure and add our custom variables back into the head of the converted script.
I appreciate your help or thinking about letting us see the added custom variables carried over with the conversion from V3 to v4 process.

[digiman57]

I did resign myself to creating a new variable section, similar to v3 format, separate and below the ADTSession variables declared. The reason for creating a separate variable section, is the conversion process, just copies over the literal format of the "extra" variables I created and used. Example, I created the variable such as $MSIName and $MSTNAME right above the Pre-Install section.
[string]$MSIName, etc. Anyway, if the conversion process copied over my custom variables in the head "ADTSession Variables," then I assume I would have to alter the body of the script and have altered the custom variables to look like this, $adtsession.MSIName. As it is, $MSIName is just copied over exactly as it is to v4 in the install section. So, I am leaving the ADTSession variables as is. If this is a bad idea, please let me know. Since the custom variables are at the head of the script, under the ADTSession variables, my custom variables are global to each of the four ADT sections. I appreciate the thought of changing the conversion process, but then if the converter tool also copied my v3 variables from the v3 Variable declaration section to the v4 ADTSession variables, it would also have to add ADTSession. to each custom variable used in the body of the script and also remove the $ from the custom variable. If this thread is better closed, just let me or feel free to close. Hopefully, this might help someone who customized the v3 scripts with custom variables.