microsoft · mazhelez · Jul 9, 2025 · May 19, 2025 · May 19, 2025 · May 20, 2025
@@ -52,11 +52,13 @@ Write-Host -ForegroundColor Yellow @'
 $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-Actions/main/Github-Helper.psm1' -folder $tmpFolder -notifyAuthenticatedAttempt
+$ReadSettingsModule = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/.Modules/ReadSettings.psm1' -folder $tmpFolder
 $ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/AL-Go-Helper.ps1' -folder $tmpFolder
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/settings.schema.json' -folder $tmpFolder | Out-Null
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/Packages.json' -folder $tmpFolder | Out-Null
 
 Import-Module $GitHubHelperPath
+Import-Module $ReadSettingsModule
 . $ALGoHelperPath -local
 
 $baseFolder = GetBaseFolder -folder $PSScriptRoot

@@ -56,11 +56,13 @@ Write-Host -ForegroundColor Yellow @'
 $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-Actions/main/Github-Helper.psm1' -folder $tmpFolder -notifyAuthenticatedAttempt
+$ReadSettingsModule = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/.Modules/ReadSettings.psm1' -folder $tmpFolder
 $ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/AL-Go-Helper.ps1' -folder $tmpFolder
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/settings.schema.json' -folder $tmpFolder | Out-Null
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/Packages.json' -folder $tmpFolder | Out-Null
 
 Import-Module $GitHubHelperPath
+Import-Module $ReadSettingsModule
 . $ALGoHelperPath -local
 
 $baseFolder = GetBaseFolder -folder $PSScriptRoot

@@ -52,11 +52,13 @@ Write-Host -ForegroundColor Yellow @'
 $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-Actions/main/Github-Helper.psm1' -folder $tmpFolder -notifyAuthenticatedAttempt
+$ReadSettingsModule = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/.Modules/ReadSettings.psm1' -folder $tmpFolder
 $ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/AL-Go-Helper.ps1' -folder $tmpFolder
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/settings.schema.json' -folder $tmpFolder | Out-Null
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/Packages.json' -folder $tmpFolder | Out-Null
 
 Import-Module $GitHubHelperPath
+Import-Module $ReadSettingsModule
 . $ALGoHelperPath -local
 
 $baseFolder = GetBaseFolder -folder $PSScriptRoot

@@ -56,11 +56,13 @@ Write-Host -ForegroundColor Yellow @'
 $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-Actions/main/Github-Helper.psm1' -folder $tmpFolder -notifyAuthenticatedAttempt
+$ReadSettingsModule = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/.Modules/ReadSettings.psm1' -folder $tmpFolder
 $ALGoHelperPath = DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/AL-Go-Helper.ps1' -folder $tmpFolder
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/settings.schema.json' -folder $tmpFolder | Out-Null
 DownloadHelperFile -url 'https://raw.githubusercontent.com/microsoft/AL-Go-Actions/main/Packages.json' -folder $tmpFolder | Out-Null
 
 Import-Module $GitHubHelperPath
+Import-Module $ReadSettingsModule
 . $ALGoHelperPath -local
 
 $baseFolder = GetBaseFolder -folder $PSScriptRoot

@@ -0,0 +1,268 @@
+Import-Module (Join-Path $PSScriptRoot '../Actions/.Modules/ReadSettings.psm1')
+
+InModuleScope ReadSettings { # Allows testing of private functions
+    Describe "ReadSettings" {
+        BeforeAll {
+            [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'scriptPath', Justification = 'False positive.')]
+            $schema = Get-Content -Path (Join-Path $PSScriptRoot '../Actions/.Modules/settings.schema.json') -Raw
+        }
+
+        It 'Reads settings from all settings locations' {
+            Mock Write-Host { }
+            Mock Out-Host { }
+
+            Push-Location
+            $tempName = Join-Path ([System.IO.Path]::GetTempPath()) ([Guid]::NewGuid().ToString())
+            $githubFolder = Join-Path $tempName ".github"
+            $ALGoFolder = Join-Path $tempName $ALGoFolderName
+            $projectALGoFolder = Join-Path $tempName "Project/$ALGoFolderName"
+
+            New-Item $githubFolder -ItemType Directory | Out-Null
+            New-Item $ALGoFolder -ItemType Directory | Out-Null
+            New-Item $projectALGoFolder -ItemType Directory | Out-Null
+
+            New-Item -Path (Join-Path $tempName "projectx/$ALGoFolderName") -ItemType Directory | Out-Null
+            New-Item -Path (Join-Path $tempName "projecty/$ALGoFolderName") -ItemType Directory | Out-Null
+
+            # Create settings files
+            # Property:    Repo:               Project (single):   Project (multi):    Workflow:           Workflow:           User:
+            #                                                                                              if(branch=dev):
+            # Property1    repo1               single1             multi1                                  branch1             user1
+            # Property2    repo2                                                       workflow2
+            # Property3    repo3
+            # Arr1         @("repo1","repo2")
+            # Property4                        single4                                                     branch4
+            # property5                                            multi5
+            # property6                                                                                                        user6
+            @{ "property1" = "repo1"; "property2" = "repo2"; "property3" = "repo3"; "arr1" = @("repo1", "repo2") } | ConvertTo-Json -Depth 99 |
+            Set-Content -Path (Join-Path $githubFolder "AL-Go-Settings.json") -encoding utf8 -Force
+            @{ "property1" = "single1"; "property4" = "single4" } | ConvertTo-Json -Depth 99 |
+            Set-Content -Path (Join-Path $ALGoFolder "settings.json") -encoding utf8 -Force
+            @{ "property1" = "multi1"; "property5" = "multi5" } | ConvertTo-Json -Depth 99 |
+            Set-Content -Path (Join-Path $projectALGoFolder "settings.json") -encoding utf8 -Force
+            @{ "property2" = "workflow2"; "conditionalSettings" = @( @{ "branches" = @( 'dev' ); "settings" = @{ "property1" = "branch1"; "property4" = "branch4" } } ) } | ConvertTo-Json -Depth 99 |
+            Set-Content -Path (Join-Path $githubFolder "Workflow.settings.json") -encoding utf8 -Force
+            @{ "property1" = "user1"; "property6" = "user6" } | ConvertTo-Json -Depth 99 |
+            Set-Content -Path (Join-Path $projectALGoFolder "user.settings.json") -encoding utf8 -Force
+
+            # No settings variables
+            $ENV:ALGoOrgSettings = ''
+            $ENV:ALGoRepoSettings = ''
+
+            # Repo only
+            $repoSettings = ReadSettings -baseFolder $tempName -project '' -repoName 'repo' -workflowName '' -branchName '' -userName ''
+            $repoSettings.property1 | Should -Be 'repo1'
+            $repoSettings.property2 | Should -Be 'repo2'
+            $repoSettings.property3 | Should -Be 'repo3'
+
+            # Repo + single project
+            $singleProjectSettings = ReadSettings -baseFolder $tempName -project '.' -repoName 'repo' -workflowName '' -branchName '' -userName ''
+            $singleProjectSettings.property1 | Should -Be 'single1'
+            $singleProjectSettings.property2 | Should -Be 'repo2'
+            $singleProjectSettings.property4 | Should -Be 'single4'
+
+            # Repo + multi project
+            $multiProjectSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName '' -branchName '' -userName ''
+            $multiProjectSettings.property1 | Should -Be 'multi1'
+            $multiProjectSettings.property2 | Should -Be 'repo2'
+            $multiProjectSettings.property5 | Should -Be 'multi5'
+
+            # Repo + workflow
+            $workflowRepoSettings = ReadSettings -baseFolder $tempName -project '' -repoName 'repo' -workflowName 'Workflow' -branchName '' -userName ''
+            $workflowRepoSettings.property1 | Should -Be 'repo1'
+            $workflowRepoSettings.property2 | Should -Be 'workflow2'
+
+            # Repo + single project + workflow
+            $workflowSingleSettings = ReadSettings -baseFolder $tempName -project '.' -repoName 'repo' -workflowName 'Workflow' -branchName '' -userName ''
+            $workflowSingleSettings.property1 | Should -Be 'single1'
+            $workflowSingleSettings.property2 | Should -Be 'workflow2'
+            $workflowSingleSettings.property4 | Should -Be 'single4'
+            $workflowSingleSettings.property3 | Should -Be 'repo3'
+
+            # Repo + multi project + workflow + dev branch
+            $workflowMultiSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'dev' -userName ''
+            $workflowMultiSettings.property1 | Should -Be 'branch1'
+            $workflowMultiSettings.property2 | Should -Be 'workflow2'
+            $workflowMultiSettings.property3 | Should -Be 'repo3'
+            $workflowMultiSettings.property4 | Should -Be 'branch4'
+            $workflowMultiSettings.property5 | Should -Be 'multi5'
+            $workflowMultiSettings.property6 | Should -BeNullOrEmpty
+
+            # Repo + multi project + workflow + dev branch + user
+            $userWorkflowMultiSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'dev' -userName 'user'
+            $userWorkflowMultiSettings.property1 | Should -Be 'user1'
+            $userWorkflowMultiSettings.property2 | Should -Be 'workflow2'
+            $userWorkflowMultiSettings.property3 | Should -Be 'repo3'
+            $userWorkflowMultiSettings.property4 | Should -Be 'branch4'
+            $userWorkflowMultiSettings.property5 | Should -Be 'multi5'
+            $userWorkflowMultiSettings.property6 | Should -Be 'user6'
+
+            # Org settings variable
+            # property 2 = orgsetting2
+            # property 7 = orgsetting7
+            # arr1 = @(org3) - gets merged
+            $ENV:ALGoOrgSettings = @{ "property2" = "orgsetting2"; "property7" = "orgsetting7"; "arr1" = @("org3") } | ConvertTo-Json -Depth 99
+
+            # Org(var) + Repo + multi project + workflow + dev branch + user
+            $withOrgSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'dev' -userName 'user'
+            $withOrgSettings.property1 | Should -Be 'user1'
+            $withOrgSettings.property2 | Should -Be 'workflow2'
+            $withOrgSettings.property3 | Should -Be 'repo3'
+            $withOrgSettings.property4 | Should -Be 'branch4'
+            $withOrgSettings.property5 | Should -Be 'multi5'
+            $withOrgSettings.property6 | Should -Be 'user6'
+            $withOrgSettings.property7 | Should -Be 'orgsetting7'
+            $withOrgSettings.arr1 | Should -Be @("org3", "repo1", "repo2")
+
+            # Repo settings variable
+            # property3 = reposetting3
+            # property8 = reposetting8
+            $ENV:ALGoRepoSettings = @{ "property3" = "reposetting3"; "property8" = "reposetting8" } | ConvertTo-Json -Depth 99
+
+            # Org(var) + Repo + Repo(var) + multi project + workflow + dev branch + user
+            $withRepoSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'dev' -userName 'user'
+            $withRepoSettings.property1 | Should -Be 'user1'
+            $withRepoSettings.property2 | Should -Be 'workflow2'
+            $withRepoSettings.property3 | Should -Be 'reposetting3'
+            $withRepoSettings.property4 | Should -Be 'branch4'
+            $withRepoSettings.property5 | Should -Be 'multi5'
+            $withRepoSettings.property6 | Should -Be 'user6'
+            $withRepoSettings.property7 | Should -Be 'orgsetting7'
+            $withRepoSettings.property8 | Should -Be 'reposetting8'
+
+            # Add conditional settings as repo(var) settings
+            $conditionalSettings = [ordered]@{
+                "conditionalSettings" = @(
+                    @{
+                        "branches" = @( 'branchx', 'branchy' )
+                        "settings" = @{ "property3" = "branchxy"; "property4" = "branchxy" }
+                    }
+                    @{
+                        "repositories" = @( 'repox', 'repoy' )
+                        "settings"     = @{ "property3" = "repoxy"; "property4" = "repoxy" }
+                    }
+                    @{
+                        "projects" = @( 'projectx', 'projecty' )
+                        "settings" = @{ "property3" = "projectxy"; "property4" = "projectxy" }
+                    }
+                    @{
+                        "workflows" = @( 'workflowx', 'workflowy' )
+                        "settings"  = @{ "property3" = "workflowxy"; "property4" = "workflowxy" }
+                    }
+                    @{
+                        "users"    = @( 'userx', 'usery' )
+                        "settings" = @{ "property3" = "userxy"; "property4" = "userxy" }
+                    }
+                    @{
+                        "branches" = @( 'branchx', 'branchy' )
+                        "projects" = @( 'projectx', 'projecty' )
+                        "settings" = @{ "property3" = "bpxy"; "property4" = "bpxy" }
+                    }
+                )
+            }
+            $ENV:ALGoRepoSettings = $conditionalSettings | ConvertTo-Json -Depth 99
+
+            # Test that conditional settings are applied correctly
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'branchy' -userName 'user'
+            $conditionalSettings.property3 | Should -Be 'branchxy'
+            $conditionalSettings.property4 | Should -Be 'branchxy'
+
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repox' -workflowName 'Workflow' -branchName 'dev' -userName 'user'
+            $conditionalSettings.property3 | Should -Be 'repoxy'
+            $conditionalSettings.property4 | Should -Be 'branch4'
+
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'projectx' -repoName 'repo' -workflowName 'Workflow' -branchName 'branch' -userName 'user'
+            $conditionalSettings.property3 | Should -Be 'projectxy'
+            $conditionalSettings.property4 | Should -Be 'projectxy'
+
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'projectx' -repoName 'repo' -workflowName 'Workflowx' -branchName 'branch' -userName 'user'
+            $conditionalSettings.property3 | Should -Be 'workflowxy'
+            $conditionalSettings.property4 | Should -Be 'workflowxy'
+
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'Project' -repoName 'repo' -workflowName 'Workflow' -branchName 'branch' -userName 'usery'
+            $conditionalSettings.property3 | Should -Be 'userxy'
+            $conditionalSettings.property4 | Should -Be 'userxy'
+
+            $conditionalSettings = ReadSettings -baseFolder $tempName -project 'projecty' -repoName 'repo' -workflowName 'Workflow' -branchName 'branchx' -userName 'user'
+            $conditionalSettings.property3 | Should -Be 'bpxy'
+            $conditionalSettings.property4 | Should -Be 'bpxy'
+
+            # Invalid Org(var) setting should throw
+            $ENV:ALGoOrgSettings = 'this is not json'
+            { ReadSettings -baseFolder $tempName -project 'Project' } | Should -Throw
+
+            $ENV:ALGoOrgSettings = ''
+            $ENV:ALGoRepoSettings = ''
+
+            # Clean up
+            Pop-Location
+            Remove-Item -Path $tempName -Recurse -Force
+        }
+
+        It 'Settings schema is valid' {
+            Test-Json -json $schema | Should -Be $true
+        }
+
+        It 'All default settings are in the schema' {
+            $defaultSettings = GetDefaultSettings
+
+            $schemaObj = $schema | ConvertFrom-Json
+
+            $defaultSettings.Keys | ForEach-Object {
+                $property = $_
+                $schemaObj.properties.PSObject.Properties.Name | Should -Contain $property
+            }
+        }
+
+        It 'Default settings match schema' {
+            $defaultSettings = GetDefaultSettings
+            Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema | Should -Be $true
+        }
+
+        It 'Shell setting can only be pwsh or powershell' {
+            $defaultSettings = GetDefaultSettings
+            $defaultSettings.shell = 42
+            try {
+                Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema
+            }
+            catch {
+                $_.Exception.Message | Should -Be "The JSON is not valid with the schema: Value is `"integer`" but should be `"string`" at '/shell'"
+            }
+
+            $defaultSettings.shell = "random"
+            try {
+                Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema
+            }
+            catch {
+                $_.Exception.Message | Should -Be "The JSON is not valid with the schema: The string value is not a match for the indicated regular expression at '/shell'"
+            }
+        }
+
+        It 'Projects setting is an array of strings' {
+            # If the projects setting is not an array, it should throw an error
+            $defaultSettings = GetDefaultSettings
+            $defaultSettings.projects = "not an array"
+            try {
+                Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema
+            }
+            catch {
+                $_.Exception.Message | Should -Be "The JSON is not valid with the schema: Value is `"string`" but should be `"array`" at '/projects'"
+            }
+
+            # If the projects setting is an array, but contains non-string values, it should throw an error
+            $defaultSettings.projects = @("project1", 42)
+            try {
+                Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema
+            }
+            catch {
+                $_.Exception.Message | Should -Be "The JSON is not valid with the schema: Value is `"integer`" but should be `"string`" at '/projects/1'"
+            }
+
+            # If the projects setting is an array of strings, it should pass the schema validation
+            $defaultSettings.projects = @("project1")
+            Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema | Should -Be $true
+            $defaultSettings.projects = @("project1", "project2")
+            Test-Json -json (ConvertTo-Json $defaultSettings) -schema $schema | Should -Be $true
+        }
+    }
+}