[CI Environment] Enabled CI environment to handle DeploymentTest (bicep) files for new self-contained dependency approach

.azuredevops/pipelineTemplates/jobs.getModuleTestFiles.yml

@@ -39,13 +39,20 @@ jobs:
             $deploymentTestPaths = Get-ModuleTestFileList @functionInput -Verbose
 
             $testTable = @{}
-            foreach($deploymentTestPath in $deploymentTestPaths) {
-              $deploymentTestFileName = Split-Path $deploymentTestPath -Leaf
-              $testTable[$deploymentTestFileName] = @{
-                moduleTestFilePath = $deploymentTestPath
-              }
+            foreach ($deploymentTestPath in $deploymentTestPaths) {
+                if((Split-Path (Split-Path $deploymentTestPath) -Leaf) -ne '.test') {
+                  # Using test files in subfolders (e.g. '.test/deploy.test.json')
+                  $deploymentTestFileName = Split-Path (Split-Path $deploymentTestPath -Parent) -Leaf
+                } else {
+                  # Using parameter files (e.g. '.test/parameters.json')
+                  $deploymentTestFileName = Split-Path $deploymentTestPath -Leaf
+                }
+                $testTable[$deploymentTestFileName] += @{
+                    moduleTestFilePath = $deploymentTestPath
+                }
             }
 
             $deploymentTestPathsOutput = $testTable | ConvertTo-Json -Compress
+
             Write-Host ('##vso[task.setVariable variable=moduleTests;isOutput=true]{0}' -f ($testTable | ConvertTo-Json -Compress))
             Write-Verbose "Module test files: $deploymentTestPathsOutput" -Verbose

.azuredevops/pipelineTemplates/jobs.validateModuleDeployment.yml

@@ -217,6 +217,7 @@ jobs:
             $moduleTemplateFilePath = Join-Path '$(System.DefaultWorkingDirectory)' '${{ parameters.templateFilePath }}'
             $moduleTestFilePath = Join-Path '$(System.DefaultWorkingDirectory)' '$(modulePath)' '$(moduleTestFilePath)'
 
+            # Determine possible parameters depending on file type
             if ((Split-Path $moduleTemplateFilePath -Extension) -eq '.bicep') {
                 $moduleTemplateContent = az bicep build --file $moduleTemplateFilePath --stdout | ConvertFrom-Json -AsHashtable
                 $moduleTemplatePossibleParameters = $moduleTemplateContent.parameters.Keys
@@ -230,13 +231,18 @@ jobs:
 
             # Building input object
             $functionInput = @{
-                templateFilePath     = $moduleTemplateFilePath
-                parameterFilePath    = $moduleTestFilePath
-                location             = $location
-                resourceGroupName    = $resourceGroupName
-                subscriptionId       = $subscriptionId
-                managementGroupId    = $managementGroupId
-                additionalParameters = @{}
+                TemplateFilePath     = ($moduleTestFilePath -like '*parameters.json') ? $moduleTemplateFilePath : $moduleTestFilePath
+                Location             = $location
+                ResourceGroupName    = $resourceGroupName
+                SubscriptionId       = $subscriptionId
+                ManagementGroupId    = $managementGroupId
+                AdditionalParameters = @{}
+            }
+
+            # Handle template file
+            if ($moduleTestFilePath -like '*parameters.json') {
+                # Original parameter file
+                $functionInput['parameterFilePath'] = $moduleTestFilePath
             }
 
             # Handle additional parameters
@@ -267,15 +273,16 @@ jobs:
             # Load used functions
             . (Join-Path '$(System.DefaultWorkingDirectory)' '$(pipelineFunctionsPath)' 'resourceDeployment' 'New-TemplateDeployment.ps1')
 
+            # Fetching parameters
             $location = '${{ parameters.location }}'
             $resourceGroupName = '${{ parameters.resourceGroupName }}'
             $subscriptionId = '${{ parameters.subscriptionId }}'
             $managementGroupId = '${{ parameters.managementGroupId }}'
 
             $moduleTemplateFilePath = Join-Path '$(System.DefaultWorkingDirectory)' '${{ parameters.templateFilePath }}'
-
             $moduleTestFilePath = Join-Path '$(System.DefaultWorkingDirectory)' '$(modulePath)' '$(moduleTestFilePath)'
 
+            # Determine possible parameters depending on file type
             if ((Split-Path $moduleTemplateFilePath -Extension) -eq '.bicep') {
                 $moduleTemplateContent = az bicep build --file $moduleTemplateFilePath --stdout | ConvertFrom-Json -AsHashtable
                 $moduleTemplatePossibleParameters = $moduleTemplateContent.parameters.Keys
@@ -289,13 +296,19 @@ jobs:
 
             # Building input object
             $functionInput = @{
-                templateFilePath     = $moduleTemplateFilePath
-                parameterFilePath    = $moduleTestFilePath
-                location             = $location
-                resourceGroupName    = $resourceGroupName
-                subscriptionId       = $subscriptionId
-                managementGroupId    = $managementGroupId
-                additionalParameters = @{}
+                TemplateFilePath     = ($moduleTestFilePath -like '*parameters.json') ? $moduleTemplateFilePath : $moduleTestFilePath
+                Location             = $location
+                ResourceGroupName    = $resourceGroupName
+                SubscriptionId       = $subscriptionId
+                ManagementGroupId    = $managementGroupId
+                doNotThrow           = $true
+                AdditionalParameters = @{}
+            }
+
+            # Handle template file
+            if ($moduleTestFilePath -like '*parameters.json') {
+                # Original paramter file
+                $functionInput['parameterFilePath'] = $moduleTestFilePath
             }
 
             # Handle additional parameters
@@ -352,9 +365,11 @@ jobs:
             . (Join-Path '$(System.DefaultWorkingDirectory)' '$(pipelineFunctionsPath)' 'resourceRemoval' 'Initialize-DeploymentRemoval.ps1')
 
             $functionInput = @{
-              TemplateFilePath  = Join-Path '$(System.DefaultWorkingDirectory)' '${{ parameters.templateFilePath }}'
+              TemplateFilePath  = ('$(moduleTestFilePath)' -like '*parameters.json') ?
+                  (Join-Path '$(System.DefaultWorkingDirectory)' '${{ parameters.templateFilePath }}') :
+                  (Join-Path '$(System.DefaultWorkingDirectory)' '$(modulePath)' '$(moduleTestFilePath)')
               ResourceGroupName = '${{ parameters.resourceGroupName }}'
-              subscriptionId    = '${{ parameters.subscriptionId }}'
+              SubscriptionId    = '${{ parameters.subscriptionId }}'
               ManagementGroupId = '${{ parameters.managementGroupId }}'
               deploymentName    = '$(deploymentName)'
               Verbose           = $true

.github/actions/templates/getModuleTestFiles/action.yml

@@ -22,13 +22,17 @@ runs:
         Write-Output '::group::Get parameter files'
         # Load used functions
         . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'sharedScripts' 'Get-ModuleTestFileList.ps1')
+
         $functionInput = @{
           ModulePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.modulePath }}'
         }
+
         Write-Verbose "Invoke task with" -Verbose
         Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
         # Get the list of parameter file paths
         $testFilePaths = Get-ModuleTestFileList @functionInput -Verbose
+
         # Output values to be accessed by next jobs
         $compressedOutput = $testFilePaths | ConvertTo-Json -Compress
         if($compressedOutput -notmatch "\[.*\]") {

.github/actions/templates/validateModuleDeployment/action.yml

@@ -211,29 +211,57 @@ runs:
           # Load used functions
           . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceDeployment' 'Test-TemplateDeployment.ps1')
 
+          # Prepare general parameters
+          # --------------------------
+          # Fetching parameters
+          $location = '${{ inputs.location }}'
+          $resourceGroupName = '${{ inputs.resourceGroupName }}'
+          $subscriptionId = '${{ inputs.subscriptionId }}'
+          $managementGroupId = '${{ inputs.managementGroupId }}'
+
+          # Determine template & test file path
+          if ('${{ inputs.templateFilePath }}' -like '*.test*') {
+            Write-Verbose 'Using template test file [${{ inputs.templateFilePath }}]' -Verbose
+            $moduleTestFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+            $moduleTemplateFilePath = Resolve-Path ('{0}/deploy.*' -f ($moduleTestFilePath | Split-Path | Split-Path | Split-Path))
+          } else {
+            Write-Verbose 'Using parameter test file [${{ inputs.parameterFilePath }}]' -Verbose
+            $moduleTestFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.parameterFilePath }}'
+            $moduleTemplateFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+          }
+
+          # Determine possible parameters depending on file type
+          if ((Split-Path $moduleTemplateFilePath -Extension) -eq '.bicep') {
+            $moduleTemplateContent = az bicep build --file $moduleTemplateFilePath --stdout | ConvertFrom-Json -AsHashtable
+            $moduleTemplatePossibleParameters = $moduleTemplateContent.parameters.Keys
+          } else {
+            $moduleTemplatePossibleParameters = ((Get-Content $moduleTemplateFilePath -Raw) | ConvertFrom-Json -AsHashtable).parameters.keys
+          }
+
           # ----------------- #
           # Invoke validation #
           # ----------------- #
           $functionInput = @{
-            templateFilePath     = '${{ inputs.templateFilePath }}'
-            location             = '${{ inputs.location }}'
-            resourceGroupName    = '${{ inputs.resourceGroupName }}'
-            subscriptionId       = '${{ inputs.subscriptionId }}'
-            managementGroupId    = '${{ inputs.managementGroupId }}'
-            additionalParameters = @{}
+            TemplateFilePath     = ($moduleTestFilePath -like '*parameters.json') ? $moduleTemplateFilePath : $moduleTestFilePath
+            Location             = $location
+            ResourceGroupName    = $resourceGroupName
+            SubscriptionId       = $subscriptionId
+            ManagementGroupId    = $managementGroupId
+            AdditionalParameters = @{}
           }
 
-          if(-not [String]::IsNullOrEmpty('${{ inputs.parameterFilePath }}')) {
-            $functionInput['parameterFilePath'] = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.parameterFilePath }}'
+          # Handle template file
+          if ($moduleTestFilePath -like '*parameters.json') {
+            $functionInput['parameterFilePath'] = $moduleTestFilePath
           }
 
-          if (-not [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}') -and (Get-Content -Path $functionInput.templateFilePath -Raw) -like '*param enableDefaultTelemetry*') {
+          if (-not [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}') -and ($moduleTemplatePossibleParameters.Keys -contains 'enableDefaultTelemetry')) {
               $functionInput['additionalParameters'] += @{
                   enableDefaultTelemetry = [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}')
               }
           }
 
-          Write-Verbose "Invoke task with" -Verbose
+          Write-Verbose 'Invoke task with' -Verbose
           Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
           Test-TemplateDeployment @functionInput -Verbose
@@ -254,30 +282,55 @@ runs:
           # Load used functions
           . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceDeployment' 'New-TemplateDeployment.ps1')
 
+          # Prepare general parameters
+          # --------------------------
+          $location = '${{ inputs.location }}'
+          $resourceGroupName = '${{ inputs.resourceGroupName }}'
+          $subscriptionId = '${{ inputs.subscriptionId }}'
+          $managementGroupId = '${{ inputs.managementGroupId }}'
+
+          # Determine template & test file path
+          if ('${{ inputs.templateFilePath }}' -like '*.test*') {
+            $moduleTestFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+            $moduleTemplateFilePath = Resolve-Path ('{0}/deploy.*' -f ($moduleTestFilePath | Split-Path | Split-Path | Split-Path))
+          } else {
+            $moduleTestFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.parameterFilePath }}'
+            $moduleTemplateFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+          }
+
+          # Determine possible parameters depending on file type
+          if ((Split-Path $moduleTemplateFilePath -Extension) -eq '.bicep') {
+            $moduleTemplateContent = az bicep build --file $moduleTemplateFilePath --stdout | ConvertFrom-Json -AsHashtable
+            $moduleTemplatePossibleParameters = $moduleTemplateContent.parameters.Keys
+          } else {
+            $moduleTemplatePossibleParameters = ((Get-Content $moduleTemplateFilePath -Raw) | ConvertFrom-Json -AsHashtable).parameters.keys
+          }
+
           # ----------------- #
           # Invoke deployment #
           # ----------------- #
           $functionInput = @{
-            templateFilePath     = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
-            location             = '${{ inputs.location }}'
-            resourceGroupName    = '${{ inputs.resourceGroupName }}'
-            subscriptionId       = '${{ inputs.subscriptionId }}'
-            managementGroupId    = '${{ inputs.managementGroupId }}'
-            doNotThrow           = $true
-            additionalParameters = @{}
+            TemplateFilePath     = ($moduleTestFilePath -like '*parameters.json') ? $moduleTemplateFilePath : $moduleTestFilePath
+            Location             = $location
+            ResourceGroupName    = $resourceGroupName
+            SubscriptionId       = $subscriptionId
+            ManagementGroupId    = $managementGroupId
+            DoNotThrow           = $true
+            AdditionalParameters = @{}
           }
 
-          if(-not [String]::IsNullOrEmpty('${{ inputs.parameterFilePath }}')) {
-            $functionInput['parameterFilePath'] = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.parameterFilePath }}'
+          # Handle template file
+          if ($moduleTestFilePath -like '*parameters.json') {
+            $functionInput['parameterFilePath'] = $moduleTestFilePath
           }
 
-          if (-not [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}') -and (Get-Content -Path $functionInput.templateFilePath -Raw) -like '*param enableDefaultTelemetry*') {
+          if (-not [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}') -and ($moduleTemplatePossibleParameters.Keys -contains 'enableDefaultTelemetry')) {
               $functionInput['additionalParameters'] += @{
                   enableDefaultTelemetry = [System.Convert]::ToBoolean('${{  env.enableDefaultTelemetry }}')
               }
           }
 
-          Write-Verbose "Invoke task with" -Verbose
+          Write-Verbose 'Invoke task with' -Verbose
           Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
           # Invoke deployment
@@ -287,11 +340,11 @@ runs:
           Write-Output ('::set-output name={0}::{1}' -f 'deploymentName', $res.deploymentName)
 
           # Populate further outputs
-          $deploymentOutputHash=@{}
+          $deploymentOutputHash = @{}
 
           foreach ($outputKey in $res.deploymentOutput.Keys) {
             Write-Output ('::set-output name={0}::{1}' -f $outputKey, $res.deploymentOutput[$outputKey].Value)
-            $deploymentOutputHash.add($outputKey,$res.deploymentOutput[$outputKey].Value)
+            $deploymentOutputHash.add($outputKey, $res.deploymentOutput[$outputKey].Value)
           }
 
           $deploymentOutput = $deploymentOutputHash | ConvertTo-Json -Compress -Depth 100
@@ -319,19 +372,17 @@ runs:
           # Load used function
           . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceRemoval' 'Initialize-DeploymentRemoval.ps1')
 
-          if (-not [String]::IsNullOrEmpty('${{ steps.deploy_step.outputs.deploymentName }}')) {
-            $functionInput = @{
-              DeploymentName    = '${{ steps.deploy_step.outputs.deploymentName }}'
-              TemplateFilePath  = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
-              ResourceGroupName = '${{ inputs.resourceGroupName }}'
-              ManagementGroupId = '${{ inputs.managementGroupId }}'
-              Verbose           = $true
-            }
+          $functionInput = @{
+            TemplateFilePath  = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+            DeploymentName    = '${{ steps.deploy_step.outputs.deploymentName }}'
+            ResourceGroupName = '${{ inputs.resourceGroupName }}'
+            ManagementGroupId = '${{ inputs.managementGroupId }}'
+            Verbose           = $true
+          }
 
-            Write-Verbose 'Invoke task with' -Verbose
-            Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+          Write-Verbose 'Invoke task with' -Verbose
+          Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
-            Initialize-DeploymentRemoval @functionInput
-          }
+          Initialize-DeploymentRemoval @functionInput
 
           Write-Output '::endgroup::'

docs/wiki/Contribution guide - Validate module locally.md

@@ -1,4 +1,4 @@
-Use this script to test a module from your PC locally, without a CI environment. You can use it to run only the static validation (Pester tests), a deployment validation (dryRun) or an actual deployment to Azure. In the latter cases the script also takes care to replace placeholder tokens in the used parameter file for you.
+Use this script to test a module from your PC locally, without a CI environment. You can use it to run only the static validation (Pester tests), a deployment validation (dryRun) or an actual deployment to Azure. In the latter cases the script also takes care to replace placeholder tokens in the used module test & template files for you.
 
 ---
 
@@ -19,14 +19,14 @@ If the switch for Pester tests (`-PesterTest`) is provided the script will
 1. Invoke the module test for the provided template file path and run all tests for it.
 
 If the switch for either the validation test (`-ValidationTest`) or deployment test (`-DeploymentTest`) is provided alongside a HashTable for the token replacement (`-ValidateOrDeployParameters`), the script will
-1. Either fetch all parameter files of the module's parameter folder (default) or you can specify a single parameter file by leveraging the `parameterFilePath` parameter instead.
-1. Create a dictionary to replace all tokens in these parameter files with actual values. This dictionary will consist
+1. Either fetch all module test files of the module's `.test` folder (default) or you can specify a single module test file by leveraging the `ModuleTestFilePath` parameter instead.
+1. Create a dictionary to replace all tokens in these module test files with actual values. This dictionary will consist
    - of the subscriptionID & managementGroupID of the provided `ValidateOrDeployParameters` object,
    - add all key-value pairs of the `-AdditionalTokens` object to it,
    - and optionally also add all key-value pairs specified in the `settings.yml`, under the 'local tokens settings'.
 1. If the `-ValidationTest` parameter was set, it runs a deployment validation using the `Test-TemplateDeployment` script.
 1. If the `-DeploymentTest` parameter was set, it runs a deployment using the `New-TemplateDeployment` script (with no retries).
-1. As a final step, it rolls the parameter files back to their original state if either the `-ValidationTest` or `-DeploymentTest` parameters were provided.
+1. As a final step, it rolls the module test files back to their original state if either the `-ValidationTest` or `-DeploymentTest` parameters were provided.
 
 # How to use it