Merge pull request AutomatedLab#1770 from dkettman/customRolePesterTests

(Fixes AutomatedLab#1764) Updated Invoke-LabPester.ps1 to now check the CustomRole directories

Author: nyanhp

AutomatedLabTest/functions/Invoke-LabPester.ps1

@@ -1,5 +1,4 @@
-function Invoke-LabPester
-{
+function Invoke-LabPester {
     [CmdletBinding(DefaultParameterSetName = 'ByLab')]
     param
     (
@@ -21,37 +20,39 @@
         $OutputFile
     )
 
-    process
-    {
-        if (-not $Lab)
-        {
+    process {
+        if (-not $Lab) {
             $Lab = Import-Lab -Name $LabName -ErrorAction Stop -NoDisplay -NoValidation -PassThru
         }
 
         $global:pesterLab = $Lab # No parameters in Pester v5 yet
         $configuration = [PesterConfiguration]::Default
-        $configuration.Run.Path = Join-Path -Path $PSCmdlet.MyInvocation.MyCommand.Module.ModuleBase -ChildPath 'tests'
+        $config_paths = @() # Setup the array to pass to $Configuration.Run.Path
+        $config_paths += Join-Path -Path $PSCmdlet.MyInvocation.MyCommand.Module.ModuleBase -ChildPath 'tests' # This is for the built-in Roles
         $configuration.Run.PassThru = $PassThru.IsPresent
         [string[]]$tags = 'General'
 
-        if ($Lab.Machines.Roles.Name)
-        {
+        if ($Lab.Machines.Roles.Name) {
             $tags += $Lab.Machines.Roles.Name
         }
-        if ($Lab.Machines.PostInstallationActivity | Where-Object IsCustomRole)
-        {
+        if ($Lab.Machines.PostInstallationActivity | Where-Object IsCustomRole) {
             $tags += ($Lab.Machines.PostInstallationActivity | Where-Object IsCustomRole).RoleName
+            foreach ( $role in (($Lab.Machines.PostInstallationActivity | Where-Object IsCustomRole).RoleName)) {
+                $config_paths += Join-Path -Path $global:LabSources\CustomRoles -ChildPath $role
+            }
         }
-        if ($Lab.Machines.PreInstallationActivity | Where-Object IsCustomRole)
-        {
+        if ($Lab.Machines.PreInstallationActivity | Where-Object IsCustomRole) {
             $tags += ($Lab.Machines.PreInstallationActivity | Where-Object IsCustomRole).RoleName
+            foreach ( $role in (($Lab.Machines.PreInstallationActivity | Where-Object IsCustomRole).RoleName)) {
+                $config_paths += Join-Path -Path $global:LabSources\CustomRoles -ChildPath $role
+            }
         }
-
+        $configuration.Run.Path = $config_paths | Sort-Object -Unique
         $configuration.Filter.Tag = $tags
         $configuration.Should.ErrorAction = 'Continue'
         $configuration.TestResult.Enabled = $true
-        if ($OutputFile)
-        {
+        
+        if ($OutputFile) {
             $configuration.TestResult.OutputPath = $OutputFile
         }
         $configuration.Output.Verbosity = $Show

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
-## Unreleased (yyyy-MM-dd)
+## Unreleased (2025-08-21)
+
+- Updated `Invoke-LabPester` to scan the `$global:LabSources\CustomRoles` directory for Pester tests (#1764)
 
 ## 5.59.0 (2025-08-18)
 

Help/AutomatedLabTest/en-us/Invoke-LabPester.md

@@ -23,7 +23,8 @@ Invoke-LabPester -LabName <String> [-Show <Object>] [-PassThru] [-OutputFile <St
 ```
 
 ## DESCRIPTION
-Invoke all role-specific pester tests for a lab
+Invoke all role-specific pester tests for a lab. This includes any tests that exist in CustomRoles. Use 
+`New-LabPesterTest` to create the Pester test stub in your Custom Role folder.
 
 ## EXAMPLES
 

Help/Wiki/Advanced/customroles.md

@@ -79,6 +79,13 @@ As AutomatedLab copies the whole folder to the machine the role is assigned to,
 & $PSScriptRoot\Customizations.ps1
 ```
 
+### Custom Role Tests
+Pester tests are now available for Custom Roles! Use `New-LabPesterTest` to create the stub test harness like this:
+
+```PowerShell
+New-LabPesterTest -Role MyCustomRole -IsCustomRole -Path $global:LabSources\CustomRoles\MyCustomRole
+```
+
 The same pattern can be used for HostStart and HostEnd as well. You do not have to put all the logic in just one file.
 
 ### Demo Roles