Fail pipeline

Author: KenitoInc

validations/Validate-EntraModule.ps1

@@ -13,4 +13,7 @@ param(
 $validator = [Validator]::new($ModuleName)
 
 $validator.ValidateScriptSubFoldersMatchDocsSubFolders()
-$validator.ValidateScriptSubFolderFilesMatchDocsSubFolderFiles()
+$validator.ValidateScriptSubFolderFilesMatchDocsSubFolderFiles()
+
+# Exit the pipeline with an error if any validation failed
+$validator.ExitPipeline()

validations/Validator.ps1

@@ -9,6 +9,7 @@ class Validator {
     [string] $ScriptsFolderPath
     [string] $DocsFolderPath
     [string[]] $SubModules
+    hidden [int] $ErrorCount
 
     # Constructor to initialize the validation paths based on the module name
     Validator([string] $Module) {
@@ -26,25 +27,29 @@ class Validator {
 
         $this.ScriptsFolderPath = (Join-Path $PSScriptRoot "../module/$Module/$($this.RootModuleName)")
         $this.DocsFolderPath = (Join-Path $PSScriptRoot "../module/docs/$($this.DocFolderName)")
+        $this.ErrorCount = 0
     }
 
     # Method to validate that script subfolders match docs subfolders
     ValidateScriptSubFoldersMatchDocsSubFolders() {
         $scriptSubModules = @(Get-ChildItem -Path $this.ScriptsFolderPath -Directory)
         $docSubModules = @(Get-ChildItem -Path $this.DocsFolderPath -Directory)
         if($scriptSubModules.Count -ne $docSubModules.Count){
+            $this.ErrorCount++
             $this.WriteWarning("Script submodules folders count ($($scriptSubModules.Count)) does not match docs submodules folders count ($($docSubModules.Count)).")
         }
 
         $missingScriptFolders = @()
         $missingDocFolders = @()
         foreach($scriptSubModule in $scriptSubModules){
             if($docSubModules.Name -notcontains $scriptSubModule.Name){
+                $this.ErrorCount++
                 $this.WriteWarning("Script submodule folder '$($scriptSubModule.Name)' does not have a corresponding docs submodule folder.")
             }
         }
         foreach($docSubModule in $docSubModules){
             if($scriptSubModules.Name -notcontains $docSubModule.Name){
+                $this.ErrorCount++
                 $this.WriteWarning("Doc submodule folder '$($docSubModule.Name)' does not have a corresponding script submodule folder.")
             }
         }
@@ -56,17 +61,20 @@ class Validator {
             $scriptFiles = @(Get-ChildItem -Path (Join-Path $this.ScriptsFolderPath $subModule) -Filter *.ps1 | Where-Object { $_.Name -ne "New-EntraCustomHeaders.ps1" -and $_.Name -ne "New-EntraBetaCustomHeaders.ps1" })
             $docFiles = @(Get-ChildItem -Path (Join-Path $this.DocsFolderPath $subModule) -File)
             if($scriptFiles.Count -ne $docFiles.Count){
+                $this.ErrorCount++
                 $this.WriteWarning("Script submodule folder '$subModule' files count ($($scriptFiles.Count)) does not match docs submodule folder '$subModule' files count ($($docFiles.Count)).")
             }
 
             foreach($scriptFile in $scriptFiles){
                 if($docFiles.BaseName -notcontains $scriptFile.BaseName){
+                    $this.ErrorCount++
                     $this.WriteWarning("Script file '$($scriptFile.BaseName)' in subfolder '$subModule' does not have a corresponding doc file.")
                 }
             }
 
             foreach($docFile in $docFiles){
                 if($scriptFiles.BaseName -notcontains $docFile.BaseName){
+                    $this.ErrorCount++
                     $this.WriteWarning("Doc file '$($docFile.BaseName)' in subfolder '$subModule' does not have a corresponding script file.")
                 }
             }
@@ -83,4 +91,13 @@ class Validator {
         Write-Host "ERROR: $message" -ForegroundColor Red
         throw $message
     }
+
+    ExitPipeline() {
+        if($this.ErrorCount -gt 0){
+            $this.WriteError("Validation failed with $($this.ErrorCount) errors.")
+        }
+        else {
+            Write-Host "Validation completed successfully."
+        }
+    }
 }