feat: Enable skip of CI deployment tests

.github/CODEOWNERS

@@ -180,3 +180,4 @@
 /avm/res/web/static-site/ @Azure/avm-res-web-staticsite-module-owners-bicep @Azure/avm-module-reviewers-bicep
 /avm/utl/types/avm-common-types/ @Azure/avm-utl-types-avmcommontypes-module-owners-bicep @Azure/avm-module-reviewers-bicep
 *avm.core.team.tests.ps1 @Azure/avm-core-team-technical-bicep
+*.e2eignore @Azure/avm-core-team-technical-bicep

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

@@ -213,7 +213,39 @@ runs:
 
     # [Deployment validation] task(s)
     # -------------------------------
+    - name: "Validate Test Execution"
+      uses: azure/powershell@v2
+      with:
+        azPSVersion: "latest"
+        inlineScript: |
+          # the first step is to check, if the deployment should be bypassed
+
+          # Resolve template file path
+          $moduleTestFilePath = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+
+          # Determine if $moduleTestFilePath is a directory or a file
+          if (Test-Path $moduleTestFilePath -PathType Container) {
+            $moduleTestFolderPath = $moduleTestFilePath
+          } else {
+            $moduleTestFolderPath = Split-Path $moduleTestFilePath
+          }
+
+          # Check if the deployment test should be bypassed
+          $passCiFilePath = Join-Path $moduleTestFolderPath '.e2eignore'
+          if (Test-Path $passCiFilePath) {
+            Write-Warning -Message "File '.e2eignore' exists in the folder: $moduleTestFolderPath"
+            $excludeReason = Get-Content $passCiFilePath
+            if ($excludeReason -ne $null) {
+              Write-Warning -Message "Reason for exclusion: $excludeReason"
+            }
+            Write-Output "skip_deployment_ci=true" >> $env:GITHUB_ENV
+          } else {
+            Write-Output "File '.e2eignore' does not exist in the folder: $moduleTestFolderPath" -Verbose
+            Write-Output "skip_deployment_ci=false" >> $env:GITHUB_ENV
+          }
+
     - name: "Validate template file"
+      if: env.skip_deployment_ci == 'false'
       uses: azure/powershell@v2
       with:
         azPSVersion: "latest"
@@ -293,6 +325,7 @@ runs:
     # [Deployment execution] task(s)
     # ------------------------------
     - name: "Deploy template file"
+      if: env.skip_deployment_ci == 'false'
       id: deploy_step
       uses: azure/powershell@v2
       with:
@@ -387,6 +420,7 @@ runs:
     # [Post-Deployment test] task(s)
     # ------------------------------
     - name: "Run post-deployment Pester tests"
+      if: env.skip_deployment_ci == 'false'
       id: pester_run_step
       shell: pwsh
       run: |
@@ -457,7 +491,7 @@ runs:
         }
 
     - name: "Output to GitHub job summaries"
-      if: steps.pester_run_step.outputs.formattedPesterResultsPath != ''
+      if: env.skip_deployment_ci == 'false' && steps.pester_run_step.outputs.formattedPesterResultsPath != ''
       shell: pwsh
       run: |
         # Grouping task logs

utilities/pipelines/staticValidation/compliance/module.tests.ps1

@@ -270,6 +270,26 @@ Describe 'File/folder tests' -Tag 'Modules' {
                 $pathExisting | Should -Be $true -Because "path [$filePath] is expected to exist."
             }
         }
+
+        It '[<moduleFolderName>] Resource Modules must not skip the "defaults" or "waf-aligned" tests with a [` .e2eignore `] file.' -TestCases $topLevelModuleTestCases {
+
+            param(
+                [string] $moduleFolderName,
+                [string] $moduleFolderPath
+            )
+
+            if ($moduleFolderName -notmatch 'res/.*') {
+                Set-ItResult -Skipped -Because 'this test only applies to resource modules.'
+                return
+            }
+
+            $e2eTestFolderPathList = Get-ChildItem -Directory (Join-Path -Path $moduleFolderPath 'tests' 'e2e') | Where-Object { $_.Name -in 'defaults', 'waf-aligned' }
+            foreach ($e2eTestFolderPath in $e2eTestFolderPathList) {
+                $filePath = Join-Path -Path $e2eTestFolderPath '.e2eignore'
+                $pathExisting = Test-Path $filePath
+                $pathExisting | Should -Be $false -Because 'skipping this test is not allowed.'
+            }
+        }
     }
 }
 

utilities/tools/Test-ModuleLocally.ps1

@@ -212,8 +212,18 @@ function Test-ModuleLocally {
             # -------------------------
             if ((Get-Item -Path $ModuleTestFilePath) -is [System.IO.DirectoryInfo]) {
                 $moduleTestFiles = (Get-ChildItem -Path $ModuleTestFilePath -File).FullName
+                $moduleTestFolderPath = $ModuleTestFilePath
             } else {
                 $moduleTestFiles = @($ModuleTestFilePath)
+                $moduleTestFolderPath = Split-Path $ModuleTestFilePath
+            }
+
+            # Check if the deployment test should be bypassed
+            $passCiFilePath = Join-Path $moduleTestFolderPath '.e2eignore'
+            if (Test-Path $passCiFilePath) {
+                Write-Output "File '.e2eignore' exists in the folder: $moduleTestFolderPath"
+                # end here, as the test should be bypassed
+                return
             }
 
             # Construct Token Configuration Input