Refactor Sync-IncludeWithModule functionality

.devcontainer/devcontainer.json

@@ -4,10 +4,10 @@
 {
 	"name": "PowerShell",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/powershell:lts-debian-11",
+	"image": "mcr.microsoft.com/powershell:lts-ubuntu-22.04",
+
 	"features": {
 		"ghcr.io/devcontainers/features/common-utils:2": {},
-		"ghcr.io/devcontainers/features/powershell:1": {},
 		"ghcr.io/devcontainers/features/sshd:1": {},
 		"ghcr.io/devcontainers/features/dotnet:1": {},
 		"ghcr.io/devcontainers/features/github-cli:1": {}
@@ -27,7 +27,9 @@
 			// Add the IDs of extensions you want installed when the container is created.
 			"extensions": [
 				"ms-vscode.powershell",
-				"github.copilot"
+				"github.copilot",
+				"GitHub.copilot-chat",
+				"mhutchie.git-graph"
 			]
 		}
 	}
@@ -38,3 +40,4 @@
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	// "remoteUser": "root"
 }
+

.github/copilot-commit-message-instructions.md

@@ -31,4 +31,4 @@ References:
 
 - https://www.conventionalcommits.org/
 - https://seesparkbox.com/foundry/semantic_commit_messages
-- http://karma-runner.github.io/1.0/dev/git-commit-msg.html
+- http://karma-runner.github.io/1.0/dev/git-commit-msg.html

.github/copilot-instructions.md

@@ -41,4 +41,4 @@ function Test_GetUserName_UserNotFound{
 
     Assert-NotImplemented
 } 
-```
+```

.github/workflows/deploy_module_on_release.yml

@@ -46,3 +46,4 @@ jobs:
           }
 
           ./deploy.ps1 -VersionTag $tag -NugetApiKey $env:NUGETAPIKEY
+

.github/workflows/powershell.yml

@@ -44,3 +44,5 @@ jobs:
         uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: results.sarif
+
+

.github/workflows/test_with_TestingHelper.yml

@@ -43,3 +43,4 @@ jobs:
           { "All test passed" | Write-Verbose -verbose ; exit 0 } 
           else 
           { "Not all tests passed" | Write-Verbose -verbose ; exit 1 }
+

CsvHelper.psm1

@@ -5,9 +5,9 @@ $MODULE_PATH = $PSScriptRoot
 
 # Load ps1 files on code folders in order
 "config","helper","include","private","public" | ForEach-Object {
-
-    Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue | ForEach-Object {
-        try { . $_.fullname }
-        catch { Write-Error -Message "Failed to import function $($import.fullname): $_" }
+    foreach ($import in Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue) {
+        try { . $import.fullname }
+        catch { Write-Error -Message "Failed to import $($import.fullname): $_" }
     }
-}
+}
+

LICENSE

@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

Test/Test.psm1

@@ -1,16 +1,13 @@
-Write-Information -Message ("Loading {0} ..." -f ($PSScriptRoot | Split-Path -Leaf)) -InformationAction continue
+Write-Information -Message ("Loading {0} ..." -f ($PSCommandPath | Split-Path -LeafBase)) -InformationAction continue
 
 #Module path is where resides the RootModule file. This file. :)
 $MODULE_PATH = $PSScriptRoot
 
 # Load ps1 files on code folders in order
 "config","helper","include","private","public" | ForEach-Object {
-
-    Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue | ForEach-Object {
-        try { . $_.fullname }
-        catch { Write-Error -Message "Failed to import function $($import.fullname): $_" }
+    foreach ($import in Get-ChildItem -Path $MODULE_PATH\$_\*.ps1 -Recurse -ErrorAction SilentlyContinue) {
+        try { . $import.fullname }
+        catch { Write-Error -Message "Failed to import $($import.fullname): $_" }
     }
 }
-
 Export-ModuleMember -Function Test_*
-

Test/helper/module.helper.ps1

@@ -0,0 +1,171 @@
+# Helper for module variables
+
+function Find-ModuleRootPath{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [string]$Path
+    )
+
+    $path = Convert-Path -Path $Path
+
+    while (-not [string]::IsNullOrWhiteSpace($Path)){
+        $psd1 = Get-ChildItem -Path $Path -Filter *.psd1 | Select-Object -First 1
+
+        if ($psd1 | Test-Path) {
+
+            if($psd1.BaseName -eq "Test"){
+                #foudn testing module. Continue
+                $path = $path | Split-Path -Parent
+                continue
+            }
+
+            # foudn module
+            return $path
+        }
+        # folder without psd1 file
+        $path = $path | Split-Path -Parent
+    }
+
+    # Path is null. Reached driver root. Module not found
+    return $null
+}
+
+$MODULE_ROOT_PATH = $PSScriptRoot | Find-ModuleRootPath
+$MODULE_NAME = (Get-ChildItem -Path $MODULE_ROOT_PATH -Filter *.psd1 | Select-Object -First 1).BaseName
+
+# Helper for module variables
+
+
+$VALID_FOLDER_NAMES = @('Include', 'Private', 'Public', 'Root', 'TestInclude', 'TestPrivate', 'TestPublic', 'TestRoot', 'Tools', 'DevContainer', 'WorkFlows', 'GitHub', 'Helper', 'Config', 'TestHelper', 'TestConfig')
+
+class ValidFolderNames : System.Management.Automation.IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+	  return $script:VALID_FOLDER_NAMES
+    }
+}
+
+function Get-Ps1FullPath{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory,Position = 0)][string]$Name,
+        [Parameter(Position = 1)][ValidateSet([ValidFolderNames])][string]$FolderName,
+        [Parameter(Position = 0)][string]$ModuleRootPath
+    )
+
+   # If folderName is not empty
+    if($FolderName -ne $null){
+        $folder = Get-ModuleFolder -FolderName $FolderName -ModuleRootPath $ModuleRootPath
+        $path = $folder | Join-Path -ChildPath $Name
+    } else {
+        $path = $Name
+    }
+
+    # Check if file exists
+    if(-Not (Test-Path $path)){
+        throw "File $path not found"
+    }
+
+    # Get Path item
+    $item = Get-item -Path $path
+
+    return $item
+}
+function Get-ModuleRootPath{
+    [CmdletBinding()]
+    param(
+        [Parameter(Position = 0)][string]$ModuleRootPath
+    )
+
+    # if ModuleRootPath is not provided, default to local module path
+    if([string]::IsNullOrWhiteSpace($ModuleRootPath)){
+        $ModuleRootPath = $MODULE_ROOT_PATH
+    }
+
+    # Convert to full path
+    $ModuleRootPath = Convert-Path -Path $ModuleRootPath
+
+    return $ModuleRootPath
+}
+
+function Get-ModuleName{
+    [CmdletBinding()]
+    param(
+        [Parameter(Position = 0)] [string]$ModuleRootPath
+    )
+
+    $ModuleRootPath = Get-ModuleRootPath -ModuleRootPath $ModuleRootPath
+
+    $MODULE_NAME = (Get-ChildItem -Path $MODULE_ROOT_PATH -Filter *.psd1 | Select-Object -First 1).BaseName
+
+
+    return $MODULE_NAME
+}
+
+function Get-ModuleFolder{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory,Position = 0)][ValidateSet([ValidFolderNames])][string]$FolderName,
+        [Parameter(Position = 1)][string]$ModuleRootPath
+    )
+
+    $ModuleRootPath = Get-ModuleRootPath -ModuleRootPath $ModuleRootPath
+
+    # TestRootPath
+    $testRootPath = $ModuleRootPath | Join-Path -ChildPath "Test"
+
+    switch ($FolderName){
+        'Public'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "public"
+        }
+        'Private'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "private"
+        }
+        'Include'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "include"
+        }
+        'TestInclude'{
+            $moduleFolder = $testRootPath | Join-Path -ChildPath "include"
+        }
+        'TestPrivate'{
+            $moduleFolder = $testRootPath | Join-Path -ChildPath "private"
+        }
+        'TestPublic'{
+            $moduleFolder = $testRootPath | Join-Path -ChildPath "public"
+        }
+        'Root'{
+            $moduleFolder = $ModuleRootPath
+        }
+        'TestRoot'{
+            $moduleFolder = $testRootPath
+        }
+        'Tools'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "tools"
+        }
+        'DevContainer'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath ".devcontainer"
+        }
+        'WorkFlows'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath ".github/workflows"
+        }
+        'GitHub'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath ".github"
+        }
+        'Helper'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "helper"
+        }
+        'Config'{
+            $moduleFolder = $ModuleRootPath | Join-Path -ChildPath "config"
+        }
+        'TestHelper'{
+            $moduleFolder = $testRootPath | Join-Path -ChildPath "helper"
+        }
+        'TestConfig'{
+            $moduleFolder = $testRootPath | Join-Path -ChildPath "config"
+        }
+        default{
+            throw "Folder [$FolderName] is unknown"
+        }
+    }
+    return $moduleFolder
+} Export-ModuleMember -Function Get-ModuleFolder

Test/include/database.mock.ps1

@@ -3,26 +3,19 @@
 # This file is used to mock the database path and the database file
 # for the tests. It creates a mock database path and a mock database file
 # and sets the database path to the mock database path.
-# We need to define variables for this include to work
-# $MOCK_DATABASE_PATH : The path used as the mock database folder
-# $DB_INVOKE_GET_ROOT_PATH_CMD : Invoke command that is needed to be mocked
-# $DB_INVOKE_GET_ROOT_PATH_ALIAS : Invoke function to retreive the root path of the database
-#
-# Sample file
-# # DATABASE MOCK VARIABLES
-# # This file is required for DATABASE MOCK to work
-# $DB_INVOKE_GET_ROOT_PATH_ALIAS = "MyModuleGetDbRootPath"
 #
+# THIS INCLUDE REQURED module.helper.ps1
+if(-not $MODULE_NAME){ throw "Missing MODULE_NAME varaible initialization. Check for module.helerp.ps1 file." }
 
-$DB_INVOKE_GET_ROOT_PATH_CMD = "Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS"
+$DB_INVOKE_GET_ROOT_PATH_CMD = "Invoke-$($MODULE_NAME)GetDbRootPath"
 $MOCK_DATABASE_PATH = "test_database_path"
 
 function Mock_Database([switch]$ResetDatabase){
 
-    MockCallToString $DB_INVOKE_GET_ROOT_PATH_CMD -OutString "test_database_path"
+    MockCallToString $DB_INVOKE_GET_ROOT_PATH_CMD -OutString $MOCK_DATABASE_PATH
 
     $dbstore = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_CMD
-    Assert-AreEqual -Expected "test_database_path" -Presented $dbstore
+    Assert-AreEqual -Expected $MOCK_DATABASE_PATH -Presented $dbstore
 
     if($ResetDatabase){
         Reset-DatabaseStore
@@ -39,10 +32,10 @@ function Reset-DatabaseStore{
     [CmdletBinding()]
     param()
 
-        $databaseRoot = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_ALIAS
+        $databaseRoot = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_CMD
 
         Remove-Item -Path $databaseRoot -Recurse -Force -ErrorAction SilentlyContinue
 
         New-Item -Path $databaseRoot -ItemType Directory
 
-}
+}