From 186b57762a152af59c81f38ad2517bd94a59d361 Mon Sep 17 00:00:00 2001 From: bcbuild-github-agent Date: Wed, 18 Sep 2024 08:58:37 +0000 Subject: [PATCH] [main] Update AL-Go System Files from microsoft/AL-Go-PTE@preview - ff5817559912b8a13b51c09368f01a623acd2082 --- .../.AL-Go/cloudDevEnv.ps1 | 101 +++++++++++ .../.AL-Go/localDevEnv.ps1 | 158 ++++++++++++++++++ 2 files changed, 259 insertions(+) create mode 100644 build/projects/System Application Tests (No Isolation)/.AL-Go/cloudDevEnv.ps1 create mode 100644 build/projects/System Application Tests (No Isolation)/.AL-Go/localDevEnv.ps1 diff --git a/build/projects/System Application Tests (No Isolation)/.AL-Go/cloudDevEnv.ps1 b/build/projects/System Application Tests (No Isolation)/.AL-Go/cloudDevEnv.ps1 new file mode 100644 index 0000000000..a720f24f19 --- /dev/null +++ b/build/projects/System Application Tests (No Isolation)/.AL-Go/cloudDevEnv.ps1 @@ -0,0 +1,101 @@ +# +# Script for creating cloud development environment +# Please do not modify this script as it will be auto-updated from the AL-Go Template +# Recommended approach is to use as is or add a script (freddyk-devenv.ps1), which calls this script with the user specific parameters +# +Param( + [string] $environmentName = "", + [bool] $reuseExistingEnvironment, + [switch] $fromVSCode, + [switch] $clean +) + +$errorActionPreference = "Stop"; $ProgressPreference = "SilentlyContinue"; Set-StrictMode -Version 2.0 + +function DownloadHelperFile { + param( + [string] $url, + [string] $folder + ) + + $prevProgressPreference = $ProgressPreference; $ProgressPreference = 'SilentlyContinue' + $name = [System.IO.Path]::GetFileName($url) + Write-Host "Downloading $name from $url" + $path = Join-Path $folder $name + Invoke-WebRequest -UseBasicParsing -uri $url -OutFile $path + $ProgressPreference = $prevProgressPreference + return $path +} + +try { +Clear-Host +Write-Host +Write-Host -ForegroundColor Yellow @' + _____ _ _ _____ ______ + / ____| | | | | __ \ | ____| + | | | | ___ _ _ __| | | | | | _____ __ |__ _ ____ __ + | | | |/ _ \| | | |/ _` | | | | |/ _ \ \ / / __| | '_ \ \ / / + | |____| | (_) | |_| | (_| | | |__| | __/\ V /| |____| | | \ V / + \_____|_|\___/ \__,_|\__,_| |_____/ \___| \_/ |______|_| |_|\_/ + +'@ + +$tmpFolder = Join-Path ([System.IO.Path]::GetTempPath()) "$([Guid]::NewGuid().ToString())" +New-Item -Path $tmpFolder -ItemType Directory -Force | Out-Null +$GitHubHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/Github-Helper.psm1' -folder $tmpFolder +$ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/AL-Go-Helper.ps1' -folder $tmpFolder +DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/Packages.json' -folder $tmpFolder | Out-Null + +Import-Module $GitHubHelperPath +. $ALGoHelperPath -local + +$baseFolder = GetBaseFolder -folder $PSScriptRoot +$project = GetProject -baseFolder $baseFolder -projectALGoFolder $PSScriptRoot + +Write-Host @' + +This script will create a cloud based development environment (Business Central SaaS Sandbox) for your project. +All apps and test apps will be compiled and published to the environment in the development scope. +The script will also modify launch.json to have a "Cloud Sandbox ()" configuration point to your environment. + +'@ + +if (Test-Path (Join-Path $PSScriptRoot "NewBcContainer.ps1")) { + Write-Host -ForegroundColor Red "WARNING: The project has a NewBcContainer override defined. Typically, this means that you cannot run a cloud development environment" +} + +Write-Host + +if (-not $environmentName) { + $environmentName = Enter-Value ` + -title "Environment name" ` + -question "Please enter the name of the environment to create" ` + -default "$($env:USERNAME)-sandbox" ` + -trimCharacters @('"',"'",' ') +} + +if ($PSBoundParameters.Keys -notcontains 'reuseExistingEnvironment') { + $reuseExistingEnvironment = (Select-Value ` + -title "What if the environment already exists?" ` + -options @{ "Yes" = "Reuse existing environment"; "No" = "Recreate environment" } ` + -question "Select behavior" ` + -default "No") -eq "Yes" +} + +CreateDevEnv ` + -kind cloud ` + -caller local ` + -environmentName $environmentName ` + -reuseExistingEnvironment:$reuseExistingEnvironment ` + -baseFolder $baseFolder ` + -project $project ` + -clean:$clean +} +catch { + Write-Host -ForegroundColor Red "Error: $($_.Exception.Message)`nStacktrace: $($_.scriptStackTrace)" +} +finally { + if ($fromVSCode) { + Read-Host "Press ENTER to close this window" + } +} diff --git a/build/projects/System Application Tests (No Isolation)/.AL-Go/localDevEnv.ps1 b/build/projects/System Application Tests (No Isolation)/.AL-Go/localDevEnv.ps1 new file mode 100644 index 0000000000..fb49fd4041 --- /dev/null +++ b/build/projects/System Application Tests (No Isolation)/.AL-Go/localDevEnv.ps1 @@ -0,0 +1,158 @@ +# +# Script for creating local development environment +# Please do not modify this script as it will be auto-updated from the AL-Go Template +# Recommended approach is to use as is or add a script (freddyk-devenv.ps1), which calls this script with the user specific parameters +# +Param( + [string] $containerName = "", + [ValidateSet("UserPassword", "Windows")] + [string] $auth = "", + [pscredential] $credential = $null, + [string] $licenseFileUrl = "", + [switch] $fromVSCode, + [switch] $accept_insiderEula, + [switch] $clean +) + +$errorActionPreference = "Stop"; $ProgressPreference = "SilentlyContinue"; Set-StrictMode -Version 2.0 + +function DownloadHelperFile { + param( + [string] $url, + [string] $folder + ) + + $prevProgressPreference = $ProgressPreference; $ProgressPreference = 'SilentlyContinue' + $name = [System.IO.Path]::GetFileName($url) + Write-Host "Downloading $name from $url" + $path = Join-Path $folder $name + Invoke-WebRequest -UseBasicParsing -uri $url -OutFile $path + $ProgressPreference = $prevProgressPreference + return $path +} + +try { +Clear-Host +Write-Host +Write-Host -ForegroundColor Yellow @' + _ _ _____ ______ + | | | | | __ \ | ____| + | | ___ ___ __ _| | | | | | _____ __ |__ _ ____ __ + | | / _ \ / __/ _` | | | | | |/ _ \ \ / / __| | '_ \ \ / / + | |____ (_) | (__ (_| | | | |__| | __/\ V /| |____| | | \ V / + |______\___/ \___\__,_|_| |_____/ \___| \_/ |______|_| |_|\_/ + +'@ + +$tmpFolder = Join-Path ([System.IO.Path]::GetTempPath()) "$([Guid]::NewGuid().ToString())" +New-Item -Path $tmpFolder -ItemType Directory -Force | Out-Null +$GitHubHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/Github-Helper.psm1' -folder $tmpFolder +$ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/AL-Go-Helper.ps1' -folder $tmpFolder +DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go/a2a51be438318a7e355fa9044815cf7890ffed1a/Actions/Packages.json' -folder $tmpFolder | Out-Null + +Import-Module $GitHubHelperPath +. $ALGoHelperPath -local + +$baseFolder = GetBaseFolder -folder $PSScriptRoot +$project = GetProject -baseFolder $baseFolder -projectALGoFolder $PSScriptRoot + +Write-Host @' + +This script will create a docker based local development environment for your project. + +NOTE: You need to have Docker installed, configured and be able to create Business Central containers for this to work. +If this fails, you can setup a cloud based development environment by running cloudDevEnv.ps1 + +All apps and test apps will be compiled and published to the environment in the development scope. +The script will also modify launch.json to have a Local Sandbox configuration point to your environment. + +'@ + +$settings = ReadSettings -baseFolder $baseFolder -project $project -userName $env:USERNAME -workflowName 'localDevEnv' + +Write-Host "Checking System Requirements" +$dockerProcess = (Get-Process "dockerd" -ErrorAction Ignore) +if (!($dockerProcess)) { + Write-Host -ForegroundColor Red "Dockerd process not found. Docker might not be started, not installed or not running Windows Containers." +} +if ($settings.keyVaultName) { + if (-not (Get-Module -ListAvailable -Name 'Az.KeyVault')) { + Write-Host -ForegroundColor Red "A keyvault name is defined in Settings, you need to have the Az.KeyVault PowerShell module installed (use Install-Module az) or you can set the keyVaultName to an empty string in the user settings file ($($ENV:UserName).settings.json)." + } +} + +Write-Host + +if (-not $containerName) { + $containerName = Enter-Value ` + -title "Container name" ` + -question "Please enter the name of the container to create" ` + -default "bcserver" ` + -trimCharacters @('"',"'",' ') +} + +if (-not $auth) { + $auth = Select-Value ` + -title "Authentication mechanism for container" ` + -options @{ "Windows" = "Windows Authentication"; "UserPassword" = "Username/Password authentication" } ` + -question "Select authentication mechanism for container" ` + -default "UserPassword" +} + +if (-not $credential) { + if ($auth -eq "Windows") { + $credential = Get-Credential -Message "Please enter your Windows Credentials" -UserName $env:USERNAME + $CurrentDomain = "LDAP://" + ([ADSI]"").distinguishedName + $domain = New-Object System.DirectoryServices.DirectoryEntry($CurrentDomain,$credential.UserName,$credential.GetNetworkCredential().password) + if ($null -eq $domain.name) { + Write-Host -ForegroundColor Red "Unable to verify your Windows Credentials, you might not be able to authenticate to your container" + } + } + else { + $credential = Get-Credential -Message "Please enter username and password for your container" -UserName "admin" + } +} + +if (-not $licenseFileUrl) { + if ($settings.type -eq "AppSource App") { + $description = "When developing AppSource Apps for Business Central versions prior to 22, your local development environment needs the developer licensefile with permissions to your AppSource app object IDs" + $default = "none" + } + else { + $description = "When developing PTEs, you can optionally specify a developer licensefile with permissions to object IDs of your dependant apps" + $default = "none" + } + + $licenseFileUrl = Enter-Value ` + -title "LicenseFileUrl" ` + -description $description ` + -question "Local path or a secure download URL to license file " ` + -default $default ` + -doNotConvertToLower ` + -trimCharacters @('"',"'",' ') +} + +if ($licenseFileUrl -eq "none") { + $licenseFileUrl = "" +} + +CreateDevEnv ` + -kind local ` + -caller local ` + -containerName $containerName ` + -baseFolder $baseFolder ` + -project $project ` + -auth $auth ` + -credential $credential ` + -licenseFileUrl $licenseFileUrl ` + -accept_insiderEula:$accept_insiderEula ` + -clean:$clean +} +catch { + Write-Host -ForegroundColor Red "Error: $($_.Exception.Message)`nStacktrace: $($_.scriptStackTrace)" +} +finally { + if ($fromVSCode) { + Read-Host "Press ENTER to close this window" + } +}