Pipeline: Streamlining & improvements

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

@@ -28,6 +28,8 @@ inputs:
 runs:
   using: 'composite'
   steps:
+    # [Setup] task(s)
+    # ----------------
     - name: 'Setup agent'
       shell: pwsh
       run: |
@@ -36,13 +38,14 @@ runs:
 
         # Set agent up
         Set-EnvironmentOnAgent
-
     - name: Azure Login
       uses: Azure/login@v1
       with:
         creds: ${{ env.AZURE_CREDENTIALS }}
         enable-AzPSSession: true
 
+    # [Token replacement] task(s)
+    # ---------------------------
     - name: 'Replace Parameter File Tokens [${{ inputs.parameterFilePath }}] '
       shell: pwsh
       run: |
@@ -58,7 +61,9 @@ runs:
             @{ Name = 'managementGroupId'; Value = '${{ inputs.managementGroupId }}' }
             @{ Name = "tenantId"; Value = '${{ env.ARM_TENANT_ID }}' }
             @{ Name = "deploymentSpId"; Value = '${{ env.DEPLOYMENT_SP_ID }}' }
-        ) | ForEach-Object { [PSCustomObject]$PSItem }
+        )
+
+        $DefaultParameterFileTokens = $DefaultParameterFileTokens | ForEach-Object { [PSCustomObject]$PSItem }
 
         # Construct Token Function Input
         $ConvertTokensInputs = @{
@@ -71,6 +76,33 @@ runs:
         # Invoke Token Replacement Functionality
         $null = Convert-TokensInParameterFile @ConvertTokensInputs -Verbose
 
+    # [Deployment validation] task(s)
+    # -------------------------
+    - name: 'Validate [${{ inputs.templateFilePath }}]'
+      shell: pwsh
+      run: |
+        # Load used functions
+        . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceValidation' 'Test-TemplateWithParameterFile.ps1')
+
+        # ----------- #
+        # INVOKE TEST #
+        # ----------- #
+        $functionInput = @{
+          templateFilePath   = '${{ inputs.templateFilePath }}'
+          parameterFilePath  = '${{ inputs.parameterFilePath }}'
+          location           = '${{ inputs.location }}'
+          resourceGroupName  = '${{ inputs.resourceGroupName }}'
+          subscriptionId     = '${{ inputs.subscriptionId }}'
+          managementGroupId  = '${{ inputs.managementGroupId }}'
+        }
+
+        Write-Verbose "Invoke task with" -Verbose
+        Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
+        Test-TemplateWithParameterFile @functionInput -Verbose
+
+    # [Deployment execution] task(s)
+    # --------------------
     - name: 'Deploy [${{ inputs.templateFilePath }}] with parameters [${{ inputs.parameterFilePath }}]'
       shell: pwsh
       id: deploy_step
@@ -95,37 +127,39 @@ runs:
         $res = New-ModuleDeployment @functionInput -Verbose
 
         # Get deployment name
-        if($res -is [hashtable]) {
-          $deploymentName = $res['DeploymentName']
-        } elseif($res -is [string]) {
-          $deploymentName = $res
-        } else {
-          throw ("Output-Type of New-ModuleDeployment invocation has invalid type [{0}]" -f $res.GetType())
+        Write-Output ('::set-output name={0}::{1}' -f 'deploymentName', $res.deploymentName)
+
+        # Populate further outputs
+        foreach ($outputKey in $res.deploymentOutput.Keys) {
+            Write-Output ('::set-output name={0}::{1}' -f $outputKey, $res.deploymentOutput[$outputKey].Value)
         }
-        Write-Output ('::set-output name=deploymentName::{0}' -f $deploymentName)
 
-        if($res -is [hashtable]) {
+        if ($res.ContainsKey('exception')) {
           # Happens only if there is an exception
-          throw $res['Exception']
+          throw $res.exception
         }
 
+    # [Deployment removal] task(s)
+    # -----------------
     - name: 'Remove [${{ inputs.templateFilePath }}] from parameters [${{ inputs.parameterFilePath }}]'
       shell: pwsh
-      if: always()
+      if: ${{ always() && steps.deploy_step.outputs.deploymentName != '' }}
       run: |
         if('${{ inputs.removeDeployment }}' -eq 'true') {
           # Load used function
           . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceRemoval' 'Remove-DeployedModule.ps1')
 
-          $functionInput = @{
+          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 }}'
               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
 
-          Remove-DeployedModule @functionInput
+            Remove-DeployedModule @functionInput
+          }
         }

.github/actions/templates/validateModuleGeneral/action.yml → .github/actions/templates/validateModulePester/action.yml

@@ -1,5 +1,5 @@
-name: 'Execute general module tests'
-description: 'Execute general module tests (if any)'
+name: 'Execute Pester module tests'
+description: 'Execute Pester module tests (if any)'
 
 inputs:
   modulePath:
@@ -27,7 +27,7 @@ runs:
 
     # [Module Pester Test] task(s)
     #-----------------------------
-    - name: 'Run tests via (Pester)'
+    - name: 'Run global tests via Pester'
       shell: pwsh
       run: |
         # --------------------- #
@@ -55,6 +55,40 @@ runs:
 
     - name: Publish Test Results
       uses: EnricoMi/publish-unit-test-result-action@v1
-      # if: always()
+      if: always()
       with:
         files: arm/.global/global-testResults.xml
+
+    # [Module Pester Test] task(s)
+    #-----------------------------
+    - name: 'Run API tests via Pester'
+      shell: pwsh
+      run: |
+        # --------------------- #
+        # Invoke Pester test(s) #
+        # --------------------- #
+        Invoke-Pester -Configuration @{
+          Run        = @{
+            Container = New-PesterContainer -Path 'arm/.global/global.module.tests.ps1' -Data @{
+              moduleFolderPaths = Join-Path $env:GITHUB_WORKSPACE "${{ inputs.modulePath }}"
+            }
+          }
+          Filter     = @{
+            Tag = 'ApiCheck'
+          }
+          TestResult = @{
+            TestSuiteName = 'Global Module API Tests'
+            OutputPath    = 'arm/.global/api-testResults.xml'
+            OutputFormat  = 'JUnitXml'
+            Enabled       = $true
+          }
+          Output     = @{
+            Verbosity = 'Detailed'
+          }
+        }
+
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v1
+      if: always()
+      with:
+        files: arm/.global/api-testResults.xml