Add CsvHelper functions to integrate with ProjectHelper

Test/include/database.mock.config.ps1

@@ -0,0 +1,4 @@
+
+# This file is part of the Database Mock Include.
+
+$DB_INVOKE_GET_ROOT_PATH_ALIAS = "CsvHelperGetDbRootPath"

Test/include/database.mock.ps1

@@ -0,0 +1,48 @@
+# DATABASE MOCK 
+#
+# 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"
+#
+
+$DB_INVOKE_GET_ROOT_PATH_CMD = "Invoke-$DB_INVOKE_GET_ROOT_PATH_ALIAS"
+$MOCK_DATABASE_PATH = "test_database_path"
+
+function Mock_Database([switch]$ResetDatabase){
+
+    MockCallToString $DB_INVOKE_GET_ROOT_PATH_CMD -OutString "test_database_path"
+
+    $dbstore = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_CMD
+    Assert-AreEqual -Expected "test_database_path" -Presented $dbstore
+
+    if($ResetDatabase){
+        Reset-DatabaseStore
+    }
+
+}
+
+function Get-Mock_DatabaseStore{
+    $dbstore = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_CMD
+    return $dbstore
+}
+
+function Reset-DatabaseStore{
+    [CmdletBinding()]
+    param()
+
+        $databaseRoot = Invoke-MyCommand -Command $DB_INVOKE_GET_ROOT_PATH_ALIAS
+
+        Remove-Item -Path $databaseRoot -Recurse -Force -ErrorAction SilentlyContinue
+
+        New-Item -Path $databaseRoot -ItemType Directory
+
+}

Test/include/invokeCommand.Mock.ps1

@@ -0,0 +1,188 @@
+
+# INVOKE COMMAND MOCK
+#
+# This includes help commands to mock invokes in a test module
+# You need to set the following variables
+# $MODULE_INVOKATION_TAG : name of the module that you are testing. This needs to match with the Tag used in the module you are testing.
+# $MODULE_INVOKATION_TAG_MOCK : Tag for the mock functions on the testing moodule you are loading this include in
+# MOCK_PATH : path to the mocks folder. This is where the mock files will be saved and loaded from.
+#
+# Sample:
+# $MODULE_INVOKATION_TAG = "SfHelperModule"
+# $MODULE_INVOKATION_TAG_MOCK = "SfHelperModule-Mock"
+# $MOCK_PATH = $PSScriptRoot | Split-Path -Parent | Join-Path -ChildPath 'private' -AdditionalChildPath 'mocks'
+
+
+function Set-InvokeCommandMock{
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory,Position=0)][string]$Alias,
+        [Parameter(Mandatory,Position=1)][string]$Command
+    )
+
+    InvokeHelper\Set-InvokeCommandAlias -Alias $Alias -Command $Command -Tag $MODULE_INVOKATION_TAG_MOCK
+} 
+
+function Reset-InvokeCommandMock{
+    [CmdletBinding()]
+    param()
+
+    # Remove all mocks
+    InvokeHelper\Reset-InvokeCommandAlias -Tag $MODULE_INVOKATION_TAG_MOCK
+
+    # Disable all dependecies of the library
+    Disable-InvokeCommandAlias -Tag $MODULE_INVOKATION_TAG
+} Export-ModuleMember -Function Reset-InvokeCommandMock
+
+function Enable-InvokeCommandAliasModule{
+    [CmdletBinding()]
+    param()
+
+    Enable-InvokeCommandAlias -Tag $MODULE_INVOKATION_TAG
+} Export-ModuleMember -Function Enable-InvokeCommandAliasModule
+
+function MockCall{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=1)][string] $filename
+    )
+
+    Assert-MockFileNotfound $fileName
+
+    Set-InvokeCommandMock -Alias $command -Command "Get-MockFileContent -filename $filename"
+}
+
+function MockCallJson{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=1)][string] $filename
+
+    )
+
+    Assert-MockFileNotfound $fileName
+
+    Set-InvokeCommandMock -Alias $command -Command "Get-MockFileContentJson -filename $filename"
+}
+
+function Get-MockFileFullPath{
+    param(
+        [parameter(Mandatory,Position=0)][string] $fileName
+    )
+
+    $filePath = $MOCK_PATH | Join-Path -ChildPath $fileName
+
+    return $filePath
+} Export-ModuleMember -Function Get-MockFileFullPath
+
+function Get-MockFileContent{
+    param(
+        [parameter(Mandatory,Position=0)][string] $fileName
+    )
+
+    Assert-MockFileNotfound $FileName
+
+    $filePath = Get-MockFileFullPath -fileName $fileName
+
+    $content = Get-Content -Path $filePath | Out-String
+
+    return $content
+} Export-ModuleMember -Function Get-MockFileContent
+
+function Get-MockFileContentJson{
+    param(
+        [parameter(Mandatory,Position=0)][string] $fileName
+    )
+
+    Assert-MockFileNotfound $FileName
+
+    $content = Get-MockFileContent -fileName $filename | ConvertFrom-Json
+
+    return $content
+} Export-ModuleMember -Function Get-MockFileContentJson
+
+function MockCallToString{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=1)][string] $OutString
+    )
+
+    $outputstring = 'echo "{output}"'
+    $outputstring = $outputstring -replace "{output}", $OutString
+
+    Set-InvokeCommandMock -Alias $command -Command $outputstring
+}
+
+function MockCallToNull{
+    param(
+        [Parameter(Position=0)][string] $command
+    )
+
+    Set-InvokeCommandMock -Alias $command -Command 'return $null'
+}
+
+function MockCallThrow{
+    param(
+        [Parameter(Position=0)][string] $command,
+        [Parameter(Position=1)][string] $ExceptionMessage
+
+    )
+
+    $mockCommand = 'throw "{message}"'
+    $mockCommand = $mockCommand -replace "{message}", $exceptionMessage
+
+    Set-InvokeCommandMock -Alias $command -Command $mockCommand
+}
+
+function Save-InvokeAsMockFile{
+    param(
+        [Parameter(Mandatory=$true)] [string]$Command,
+        [Parameter(Mandatory=$true)] [string]$FileName,
+        [Parameter(Mandatory=$false)] [switch]$Force
+    )
+
+    $filePath = Get-MockFileFullPath -fileName $fileName
+
+    $result = Invoke-Expression -Command $Command
+
+    $json = $result | ConvertTo-Json -Depth 100 
+
+    $json | Out-File -FilePath $filePath
+
+    Write-Host $FileName
+} Export-ModuleMember -Function Save-InvokeAsMockFile
+
+function Save-InvokeAsMockFileJson{
+    param(
+        [Parameter(Mandatory=$true)] [string]$Command,
+        [Parameter(Mandatory=$true)] [string]$FileName
+    )
+
+    $filePath = Get-MockFileFullPath -fileName $fileName
+
+    $result = Invoke-Expression -Command $Command
+
+    $result | Out-File -FilePath $filePath
+
+    Write-Host $FileName
+} Export-ModuleMember -Function Save-InvokeAsMockFileJson
+
+function Assert-MockFileNotfound{
+    param(
+        [Parameter(Mandatory=$true,Position=0)] [string]$FileName
+    )
+
+    $filePath = Get-MockFileFullPath -fileName $fileName
+
+    if(-Not (Test-Path -Path $filePath)){
+        throw "File not found: $fileName"
+    }
+
+    # Throw if $file.name and the $filename parameter have different case
+    # We need to check this to avoid test bugs for mock files not found on linux that the FS is case sensitive
+    $file = Get-ChildItem -Path $MOCK_PATH | Where-Object { $_.Name.ToLower() -eq $fileName.ToLower() }
+    if($file.name -cne $fileName){
+        Write-host "Wait-Debugger - File not found or wrong case - $($file.name)"
+        Wait-Debugger
+        throw "File not found or wrong case name. Expected[ $filename ] - Found[$( $file.name )]"
+    }
+}

Test/private/NewCsvTestFile.ps1

@@ -0,0 +1,21 @@
+function New-TestCsvFile {
+    param (
+        [int]$NumRows = 10,
+        [string]$Path = "test.csv"
+    )
+
+    $data = @()
+
+    for ($i = 1; $i -le $numRows; $i++) {
+        $data += [PSCustomObject]@{
+            Id = "ValueId_$i"
+            Column1 = "Value1_$i"
+            Column2 = "Value2_$i"
+            Column3 = "Value3_$i"
+        }
+    }
+
+    $data | Export-Csv -Path $Path -NoTypeInformation
+
+    return $Path
+}

Test/public/CsvFile.test.ps1

@@ -0,0 +1,49 @@
+
+function Test_GetCsvFile{
+
+    Mock_Database -resetDatabase
+    $databaseRoot = Get-Mock_DatabaseStore
+    $csvPath = New-TestCsvFile
+
+    # Act
+    $key = Import-CsvFile -Path $csvPath -KeyColumn "Column1"
+
+    # Assert
+    Assert-IsNotNull -Object $key
+    Assert-Count -Expected 1 -Presented (Get-ChildItem -Path $databaseRoot)
+    Assert-ItemExist -Path "$databaseRoot/$key.json"
+
+    # read database file from json
+    $data = Get-Content -Path "$databaseRoot/$key.json" | ConvertFrom-Json -Depth 10 -AsHashtable
+
+    # Random record
+    $i = 5
+    $record2 = $data["Value1_$i"]
+
+    Assert-AreEqual -Expected "Value1_$i" -Presented $record2.Column1
+    Assert-AreEqual -Expected "Value2_$i" -Presented $record2.Column2
+    Assert-AreEqual -Expected "Value3_$i" -Presented $record2.Column3
+}
+
+function Test_GetCsvFile_Default_Id{
+
+    Mock_Database -resetDatabase
+    $databaseRoot = Get-Mock_DatabaseStore
+    $csvPath = New-TestCsvFile
+
+    # Act
+    $key = Import-CsvFile -Path $csvPath
+
+    # Assert
+    # read database file from json
+    $data = Get-Content -Path "$databaseRoot/$key.json" | ConvertFrom-Json -Depth 10 -AsHashtable
+
+    # Random record
+    $i = 5
+    $record2 = $data["ValueId_$i"]
+
+    Assert-AreEqual -Expected "Value1_$i" -Presented $record2.Column1
+    Assert-AreEqual -Expected "Value2_$i" -Presented $record2.Column2
+    Assert-AreEqual -Expected "Value3_$i" -Presented $record2.Column3
+}
+

Test/public/CsvRecord.test.ps1

@@ -0,0 +1,53 @@
+
+function Test_GetCsvRecord{
+
+    Mock_Database -resetDatabase
+
+    $csvPath = New-TestCsvFile
+
+    $key = Import-CsvFile -Path $csvPath -KeyColumn "Column1"
+
+    Assert-IsNotNull -Object $key
+
+    # Act get record with csv with path
+    $record = Get-CsvRecord -Path $csvPath -KeyColumn "Column1" -Id "Value1_2"
+
+    Assert-AreEqual -Expected "Value1_2" -Presented $record.Column1
+    Assert-AreEqual -Expected "Value2_2" -Presented $record.Column2
+    Assert-AreEqual -Expected "Value3_2" -Presented $record.Column3
+
+    # Call with Key
+    $record = Get-CsvRecord -Key $key -Id "Value1_3"
+
+    Assert-AreEqual -Expected "Value1_3" -Presented $record.Column1
+    Assert-AreEqual -Expected "Value2_3" -Presented $record.Column2
+    Assert-AreEqual -Expected "Value3_3" -Presented $record.Column3
+}
+
+function Test_GetCsvRecord_Integration{
+
+    Mock_Database -resetDatabase
+
+    $csvPath = New-TestCsvFile
+
+   # Act get record with csv with path
+   $record = Get-CsvRecord -Path $csvPath -KeyColumn "Column1" -Id "Value1_2" 
+
+   Assert-AreEqual -Expected "Value1_2" -Presented $record.Column1
+   Assert-AreEqual -Expected "Value2_2" -Presented $record.Column2
+   Assert-AreEqual -Expected "Value3_2" -Presented $record.Column3
+}
+
+function Test_GetCsvRecord_Integration_Id{
+
+    Mock_Database -resetDatabase
+
+    $csvPath = New-TestCsvFile
+
+   # Act get record with csv with path
+   $record = Get-CsvRecord -Path $csvPath -Id "ValueId_2" 
+
+   Assert-AreEqual -Expected "Value1_2" -Presented $record.Column1
+   Assert-AreEqual -Expected "Value2_2" -Presented $record.Column2
+   Assert-AreEqual -Expected "Value3_2" -Presented $record.Column3
+}