[IncludeHelper] Improvements and Fixing

.github/copilot-pull-request-description-instructions.md

@@ -37,5 +37,4 @@ References:
 
 ## Pull Request description
 
-- Add a summary of the intention of the PR. Use the title and the messages of the commits to create a summary.
-- Add a bullet list with all the commit messages in the PR commits.
+- Add a bullet list with all the commit messages in the PR commits. Use the full commit message. Do not remove the Semantic header.

.gitignore

@@ -320,4 +320,7 @@ OpenCover/
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
-*.binlog
+*.binlog
+
+# Mack
+**/.DS_Store

Test/helper/module.helper.ps1

@@ -1,3 +1,5 @@
+# {"Version":"v1.0.0","Date":"2026-06-14"}
+#
 # Helper for module variables
 
 function Find-ModuleRootPath{
@@ -7,19 +9,31 @@ function Find-ModuleRootPath{
         [string]$Path
     )
 
-    $path = Convert-Path -Path $Path
+    $path = Resolve-Path -Path $Path
 
     while (-not [string]::IsNullOrWhiteSpace($Path)){
         $psd1 = Get-ChildItem -Path $Path -Filter *.psd1 | Select-Object -First 1
 
         if ($psd1 | Test-Path) {
 
+            # Skip if module found is Test
             if($psd1.BaseName -eq "Test"){
                 #foudn testing module. Continue
                 $path = $path | Split-Path -Parent
                 continue
             }
 
+            # It can happen that on a parent folder of a folder there is a lost psd1 file.
+            # Confirm that the psd1 file name equals the folder name
+            # Found this bug because on the test machine there was a psd1 on a tempo folder parent of the testing folder.
+            # This may break modules where the psd1 does not match the folder name
+            $folderName = Split-Path -Path $path -Leaf
+            if ($psd1.BaseName -ne $folderName) {
+                # psd1 file no on folder name
+                $path = $path | Split-Path -Parent
+                continue
+            }
+
             # foudn module
             return $path
         }

Test/include/Mock-SaveParameterToVariable.ps1

@@ -0,0 +1,69 @@
+# Mock-SaveParameterToVariable
+#
+# Allows mocking commands using a temp varible for the content.
+#
+# When the parameters for an invoke is too big as string, we can use a json
+# as a single parameter to hold all the parameters wanted.
+#
+# We can use this Mock functions to mock the calls to this invokes that use a json to 
+# transfer an object as parameter.
+
+function Reset-MockSaveParameterToVariable {
+
+    $script:varCommands = @{}
+}
+
+function Get-MockSavedParameterFromVariable ($Command){
+
+    $result = $script:varCommands[$Command]
+
+    if ($nulll -eq $result) {
+        throw "Command [$Command] was not initialized."
+    }
+
+    return $result
+
+}
+
+function Invoke-MockSaveParameterToVariable{
+    param(
+        [Parameter(Position=0)][string] $Command,
+        [Parameter(Position=1)][string] $json,
+        [Parameter(Position=2)][string] $FileName,
+        [Parameter()][switch] $ashashtable
+    )
+
+    # Save call to Variable
+    $script:varCommands.$Command += $json
+
+    # Return some value from FielName if provided
+    if(-Not [string]::IsNullOrWhiteSpace($FileName)){
+
+        $ret = Get-MockFileContentJson -filename $FileName -asHashtable:$ashashtable
+
+        return $ret
+    }
+
+} Export-ModuleMember -Function Invoke-MockSaveParameterToVariable
+
+function MockCallJson_SaveParametersToVariable{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=2)][string] $fileName,
+        [Parameter()][switch] $ashashtable
+    )
+
+    # Prepare variable to receive calls
+    $script:varCommands.$Command = @()
+
+    # Mock call back leaving {json} as the parameter to be replaced by the call
+    $mockCommand = 'Invoke-MockSaveParameterToVariable "{command}" ''{json}'' "{fileName}" -ashashtable:${ashashtable}'
+    $mockCommand = $mockCommand -replace "{command}", $command
+    $mockCommand = $mockCommand -replace "{fileName}", $fileName
+    $mockCommand = $mockCommand -replace "{json}", '{json}'
+    $mockCommand = $mockCommand -replace "{ashashtable}", $ashashtable.IsPresent.ToString()
+
+    # Set invoke command mock with the prepared command
+    Set-InvokeCommandMock -Alias $command -Command $mockCommand
+
+  }

Test/include/base64.ps1

@@ -0,0 +1,24 @@
+function ConvertTo-Base64 {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory,ValueFromPipeline, Position=0)][string[]]$Text
+    )
+
+    process{
+        # Encode the string to base64
+        $ret = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($Text))
+        return $ret
+    }
+}
+
+function ConvertFrom-Base64 {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory,ValueFromPipeline, Position=0)][string[]]$Text
+    )
+
+    process{
+        $ret = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Text))
+        return $ret
+    }
+}

Test/include/callPrivateContext.ps1

@@ -16,7 +16,7 @@ function Invoke-PrivateContext {
         [Parameter(Mandatory, Position = 0)]
         [scriptblock]$ScriptBlock,
         [string]$ModulePath,
-        [string[]]$Arguments
+        [object[]]$Arguments
     )
 
     if ([string]::IsNullOrEmpty($ModulePath)) {

Test/include/invokeCommand.mock.ps1

@@ -1,3 +1,6 @@
+# {"Version":"1.0.0","Date":"2026-06-17","HeaderVersion":1}
+# DO NOT MODIFY THIS FILE MANUALLY. IT IS GENERATED BY THE IncludeHelper MODULE.
+#
 
 # INVOKE COMMAND MOCK
 #
@@ -200,6 +203,17 @@ function MockCallToString{
     Set-InvokeCommandMock -Alias $command -Command $outputstring
 }
 
+function MockCallToBool{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=1)][bool] $OutBool
+    )
+
+    $outputstring = $outBool ? 'return $true' : 'return $false'
+
+    Set-InvokeCommandMock -Alias $command -Command $outputstring
+}
+
 
 function MockCallToObject{
     param(
@@ -242,11 +256,6 @@ function MockCallExpression{
         [Parameter(Position=1)][string] $expression
     )
 
-    $mockCommand = @'
-    Invoke-Expression -Command '{expression}'
-'@
-    $mockCommand = $mockCommand -replace "{expression}", $expression
-
     Set-InvokeCommandMock -Alias $command -Command $expression
 }
 

Test/public/MyWrite.test.ps1

@@ -6,7 +6,7 @@
         Write-MyHost -Message "This is a test transcript."
     }
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-AreEqual -Expected "This is a test transcript." -Presented $result
 
@@ -20,7 +20,7 @@
         Write-MyHost -Message "This is a test transcript 0"
         Write-MyHost -Message "This is a test transcript 1"
     }
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-AreEqual -Expected "This is a test transcript 0" -Presented $result[0]
@@ -109,16 +109,14 @@
 
      } -Arguments $text0,$text1
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-DbgMsg $result[0] "none" $text0
     Assert-DbgMsg $result[1] "none" $text1
 
 }
 
-
-
 function Test_EnableMyDebug_All_Sections{
 
     Enable-IncludeHelperDebug
@@ -136,7 +134,7 @@
 
     } -Arguments $text0,$text1
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-DbgMsg $result[0] "section0" $text0
@@ -162,7 +160,7 @@
 
         } -Arguments $text0,$text1,$text2   
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-DbgMsg $result[0] "section0" $text0
@@ -188,7 +186,7 @@
 
         } -Arguments $text0,$text1,$text2   
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-DbgMsg $result[0] "section0" $text0
@@ -216,7 +214,7 @@
 
         } -Arguments $text0,$text1,$text2 ,$text3
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 2 -Presented $result
     Assert-DbgMsg $result[0] "section0" $text0
@@ -247,7 +245,7 @@
 
         } -Arguments $text0,$text1,$text2 ,$text3
 
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
 
     Assert-Count -Expected 4 -Presented $result
 
@@ -259,6 +257,62 @@
     Assert-DbgMsg $result[3] "section3" $text3
 }
 
+function Test_EnableMyDebug_SectionWithAll{
+
+    Enable-IncludeHelperDebug -Sections "algoconall"
+
+    $text0 = "Debug message 0"
+    $text1 = "Debug message 1"
+    $text2 = "Debug message 2"
+    $text3 = "Debug message 3"
+
+    Start-MyTranscript
+
+        Invoke-PrivateContext {
+        param($Arguments)
+
+        Write-MyDebug -Message $Arguments[0] -Section "section0"
+        Write-MyDebug -Message $Arguments[1] -Section "section1"
+        Write-MyDebug -Message $Arguments[2] -Section "algoconall"
+        Write-MyDebug -Message $Arguments[3] -Section "section3"
+
+        } -Arguments $text0,$text1,$text2 ,$text3
+
+    $result = @(Stop-MyTranscript)
+
+    Assert-Count -Expected 1 -Presented $result
+    Assert-DbgMsg $result[0] "algoconall" $text2
+}
+
+function Test_EnableMyDebug_SectionUpperCase{
+
+    Enable-IncludeHelperDebug -Sections "alGocOnall"
+
+    $text0 = "Debug message 0"
+    $text1 = "Debug message 1"
+    $text2 = "Debug message 2"
+    $text3 = "Debug message 3"
+
+    Start-MyTranscript
+
+        Invoke-PrivateContext {
+        param($Arguments)
+
+        Write-MyDebug -Message $Arguments[0] -Section "section0"
+        Write-MyDebug -Message $Arguments[1] -Section "section1"
+        Write-MyDebug -Message $Arguments[2] -Section "alGocOnall"
+        Write-MyDebug -Message $Arguments[3] -Section "algoconall"
+        Write-MyDebug -Message $Arguments[3] -Section "section3"
+
+        } -Arguments $text0,$text1,$text2 ,$text3
+
+    $result = @(Stop-MyTranscript)
+
+    Assert-Count -Expected 2 -Presented $result
+    Assert-DbgMsg $result[0] "algoconall" $text2
+    Assert-DbgMsg $result[1] "algoconall" $text3
+}
+
 function Assert-DbgMsg($Presented,$Section,$Message){
 
     Assert-IsTrue -Condition ($Presented -match "^\[\d{2}:\d{2}:\d{2}\.\d{3}\]\[IncludeHelper\]\[D\]\[$Section\] $Message$")

Test/public/copyIncludeToWorkspace.test.ps1

@@ -4,7 +4,7 @@ function Test_CopyIncludeToWorkspace{
     New-ModuleV3 -Name TestModule
 
     # Test for Include
-    $name = "sync.Helper.ps1"
+    $name = "deploy.Helper.ps1"
     $folderPath = "tools"
     $destinationModulePath = "TestModule"
 

Test/public/dependencies.test.ps1

@@ -80,7 +80,7 @@ function Test_ImportDepepency_Import_From_Module_Manager{
     Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
     Disable-IncludeHelperVerbose
 
     #Assert verbose message
@@ -122,7 +122,7 @@ function Test_ImportDepepency_Install_From_Gallery{
     Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
     Disable-IncludeHelperVerbose
 
     #Assert verbose message
@@ -157,7 +157,7 @@ function Test_ImportDependency_Clone_From_GitHub{
     Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
-    $result = Stop-MyTranscript
+    $result = @(Stop-MyTranscript)
     Disable-IncludeHelperVerbose
 
     #Assert verbose message