mirror of
https://github.com/dfinke/ImportExcel.git
synced 2025-12-06 00:23:20 +00:00
Bumped version to 4.0.1
- Renamed 'TopRow' to 'StartRow' and added alias (More concise with future parameter names like 'StartColumn') - Removed 'ChangeList' in 'Notes' as this is tracked in Git - Added parameter 'Password' to import password protected files - Added Pester tests for parameter aliasses and: - parameter 'Password' - parameter 'Path' validation for extensions '.xls' and '.xlsx' - 'HeaderName' witb blanks - Changed comments in Pester tests from '<# Comment #>' to '# Comment' (Easier to outcomment a whole block of tests when performing a test on a specific piece of code)
This commit is contained in:
DarkLite1
@@ -11,7 +11,7 @@ $WarningPreference = 'SilentlyContinue'
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
|
||||
$Path = 'Test.xlsx'
|
||||
|
||||
#<#
|
||||
Context 'input' {
|
||||
in $TestDrive {
|
||||
Describe 'parameters' {
|
||||
@@ -33,28 +33,62 @@ Context 'input' {
|
||||
it 'DataOnly' {
|
||||
(Get-Command Import-Excel).Parameters['DataOnly'].Attributes.Mandatory | Should be $false
|
||||
}
|
||||
it 'TopRow' {
|
||||
(Get-Command Import-Excel).Parameters['TopRow'].Attributes.Mandatory | Should be $false
|
||||
it 'StartRow' {
|
||||
(Get-Command Import-Excel).Parameters['StartRow'].Attributes.Mandatory | Should be $false
|
||||
}
|
||||
it 'WorksheetName' {
|
||||
(Get-Command Import-Excel).Parameters['WorksheetName'].Attributes.Mandatory | Should be $false
|
||||
}
|
||||
it 'Password' {
|
||||
(Get-Command Import-Excel).Parameters['Password'].Attributes.Mandatory | Should be $false
|
||||
}
|
||||
}
|
||||
Context 'aliases' {
|
||||
it 'Path' {
|
||||
(Get-Command Import-Excel).Parameters['Path'].Attributes.AliasNames | Should be 'FullName'
|
||||
}
|
||||
it 'WorksheetName' {
|
||||
(Get-Command Import-Excel).Parameters['WorksheetName'].Attributes.AliasNames | Should be 'Sheet'
|
||||
}
|
||||
it 'StartRow' {
|
||||
(Get-Command Import-Excel).Parameters['StartRow'].Attributes.AliasNames | Should be @('HeaderRow','TopRow')
|
||||
}
|
||||
}
|
||||
Context 'illegal' {
|
||||
it 'NoHeader combined with HeaderName' {
|
||||
'Kiwi'| Export-Excel -Path $Path -WorkSheetname Fruit
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName A -NoHeader} | Should Throw 'Parameter set cannot be resolved'
|
||||
}
|
||||
it 'HeaderName with blanks' {
|
||||
'Kiwi'| Export-Excel -Path $Path -WorkSheetname Fruit
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName A, $null, C} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName $null, C} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName $null} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName A, '', C} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName '', C} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -HeaderName ''} | Should Throw "Cannot bind argument to parameter 'HeaderName'"
|
||||
}
|
||||
it 'Path does not exist' {
|
||||
{Import-Excel -Path D:\DontExist -WorksheetName Fruit} | Should Throw "Cannot validate argument on parameter 'Path'"
|
||||
}
|
||||
it 'Path exists but does not have extension .xlsx or .xls' {
|
||||
'Kiwi' | Out-File NotAnExcelFile.txt
|
||||
Test-Path -Path NotAnExcelFile.txt -PathType Leaf | Should be $true
|
||||
{Import-Excel -Path NotAnExcelFile.txt -WorksheetName Fruit} | Should Throw "Cannot validate argument on parameter 'Path'"
|
||||
}
|
||||
it 'WorksheetName left blank' {
|
||||
'Kiwi'| Export-Excel -Path $Path -WorkSheetname Fruit
|
||||
{Import-Excel -Path $Path -WorksheetName $null} | Should Throw "Cannot validate argument on parameter 'WorksheetName'. The argument is null or empty"
|
||||
{Import-Excel -Path $Path -WorksheetName ''} | Should Throw "Cannot validate argument on parameter 'WorksheetName'. The argument is null or empty"
|
||||
}
|
||||
it 'Password left blank' {
|
||||
'Kiwi'| Export-Excel -Path $Path -WorkSheetname Fruit
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -Password $null} | Should Throw "Cannot validate argument on parameter 'Password'. The argument is null or empty"
|
||||
{Import-Excel -Path $Path -WorksheetName Fruit -Password ''} | Should Throw "Cannot validate argument on parameter 'Password'. The argument is null or empty"
|
||||
}
|
||||
}
|
||||
Context 'omit paramter name' {
|
||||
Context 'omit parameter name' {
|
||||
it 'Path' {
|
||||
[PSCustomObject]@{
|
||||
Number = 1
|
||||
@@ -102,36 +136,34 @@ Context 'input' {
|
||||
}
|
||||
}
|
||||
Describe 'worksheet' {
|
||||
in $TestDrive {
|
||||
#region Create test file
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Excel | Add-WorkSheet -WorkSheetname Test
|
||||
$Excel.Save()
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
#region Create test file
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Excel | Add-WorkSheet -WorkSheetname Test
|
||||
$Excel.Save()
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
|
||||
it 'not found' {
|
||||
{Import-Excel -Path $Path -WorksheetName NotExisting} | Should Throw 'not found'
|
||||
}
|
||||
it 'empty' {
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader | Should BeNullOrEmpty
|
||||
}
|
||||
it 'select first worksheet by default' {
|
||||
Remove-Item ./* -Force
|
||||
#region Create test file
|
||||
it 'not found' {
|
||||
{Import-Excel -Path $Path -WorksheetName NotExisting} | Should Throw 'not found'
|
||||
}
|
||||
it 'empty' {
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader | Should BeNullOrEmpty
|
||||
}
|
||||
it 'select first worksheet by default' {
|
||||
Remove-Item ./* -Force
|
||||
#region Create test file
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
|
||||
<#
|
||||
----------------------------------------------
|
||||
| A B C |
|
||||
|1 First Name Address |
|
||||
|2 Chuck Norris California |
|
||||
|3 Jean-Claude Vandamme Brussels |
|
||||
----------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ----------------------------------------------
|
||||
# | A B C |
|
||||
# |1 First Name Address |
|
||||
# |2 Chuck Norris California |
|
||||
# |3 Jean-Claude Vandamme Brussels |
|
||||
# ----------------------------------------------
|
||||
|
||||
# Row, Column
|
||||
$WorksheetActors = $Excel | Add-WorkSheet -WorkSheetname Actors
|
||||
$WorksheetActors.Cells[1, 1].Value = 'First Name'
|
||||
@@ -143,17 +175,15 @@ Context 'input' {
|
||||
$WorksheetActors.Cells[3, 2].Value = 'Vandamme'
|
||||
$WorksheetActors.Cells[3, 3].Value = 'Brussels'
|
||||
|
||||
<#
|
||||
---------------------------------------------------------------------
|
||||
| A B C D E |
|
||||
|1 Movie name Year Rating Genre |
|
||||
|2 The Bodyguard 1992 9 Thriller |
|
||||
|3 The Matrix 1999 8 Sci-Fi |
|
||||
|4 |
|
||||
|5 Skyfall 2012 9 Thriller |
|
||||
---------------------------------------------------------------------
|
||||
#>
|
||||
|
||||
# ---------------------------------------------------------------------
|
||||
# | A B C D E |
|
||||
# |1 Movie name Year Rating Genre |
|
||||
# |2 The Bodyguard 1992 9 Thriller |
|
||||
# |3 The Matrix 1999 8 Sci-Fi |
|
||||
# |4 |
|
||||
# |5 Skyfall 2012 9 Thriller |
|
||||
# ---------------------------------------------------------------------
|
||||
|
||||
# Row, Column
|
||||
$WorksheetMovies = $Excel | Add-WorkSheet -WorkSheetname Movies
|
||||
$WorksheetMovies.Cells[1, 1].Value = 'Movie name'
|
||||
@@ -177,7 +207,7 @@ Context 'input' {
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
|
||||
$ExpectedResult = @(
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'First Name' = 'Chuck'
|
||||
'Address' = 'California'
|
||||
@@ -188,26 +218,24 @@ Context 'input' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
$Result = Import-Excel -Path $Path
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Remove-Item ./* -Force
|
||||
Remove-Item ./* -Force
|
||||
|
||||
#region Create test file
|
||||
#region Create test file
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
|
||||
<#
|
||||
---------------------------------------------------------------------
|
||||
| A B C D E |
|
||||
|1 Movie name Year Rating Genre |
|
||||
|2 The Bodyguard 1992 9 Thriller |
|
||||
|3 The Matrix 1999 8 Sci-Fi |
|
||||
|4 |
|
||||
|5 Skyfall 2012 9 Thriller |
|
||||
---------------------------------------------------------------------
|
||||
#>
|
||||
|
||||
# ---------------------------------------------------------------------
|
||||
# | A B C D E |
|
||||
# |1 Movie name Year Rating Genre |
|
||||
# |2 The Bodyguard 1992 9 Thriller |
|
||||
# |3 The Matrix 1999 8 Sci-Fi |
|
||||
# |4 |
|
||||
# |5 Skyfall 2012 9 Thriller |
|
||||
# ---------------------------------------------------------------------
|
||||
|
||||
# Row, Column
|
||||
$WorksheetMovies = $Excel | Add-WorkSheet -WorkSheetname Movies
|
||||
$WorksheetMovies.Cells[1, 1].Value = 'Movie name'
|
||||
@@ -227,15 +255,13 @@ Context 'input' {
|
||||
$WorksheetMovies.Cells[5, 3].Value = '9'
|
||||
$WorksheetMovies.Cells[5, 5].Value = 'Thriller'
|
||||
|
||||
<#
|
||||
----------------------------------------------
|
||||
| A B C |
|
||||
|1 First Name Address |
|
||||
|2 Chuck Norris California |
|
||||
|3 Jean-Claude Vandamme Brussels |
|
||||
----------------------------------------------
|
||||
#>
|
||||
|
||||
# ----------------------------------------------
|
||||
# | A B C |
|
||||
# |1 First Name Address |
|
||||
# |2 Chuck Norris California |
|
||||
# |3 Jean-Claude Vandamme Brussels |
|
||||
# ----------------------------------------------
|
||||
|
||||
# Row, Column
|
||||
$WorksheetActors = $Excel | Add-WorkSheet -WorkSheetname Actors
|
||||
$WorksheetActors.Cells[1, 1].Value = 'First Name'
|
||||
@@ -251,7 +277,7 @@ Context 'input' {
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
|
||||
$ExpectedResult = @(
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'Movie name' = 'The Bodyguard'
|
||||
'Year' = '1982'
|
||||
@@ -278,9 +304,8 @@ Context 'input' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
$Result = Import-Excel -Path $Path
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -291,15 +316,14 @@ Context 'output' {
|
||||
Describe 'missing column header' {
|
||||
|
||||
#region Create test file
|
||||
<#
|
||||
----------------------------------------------
|
||||
| A B C |
|
||||
|1 First Name Address |
|
||||
|2 Chuck Norris California |
|
||||
|3 Jean-Claude Vandamme Brussels |
|
||||
----------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ----------------------------------------------
|
||||
# | A B C |
|
||||
# |1 First Name Address |
|
||||
# |2 Chuck Norris California |
|
||||
# |3 Jean-Claude Vandamme Brussels |
|
||||
# ----------------------------------------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
@@ -333,17 +357,17 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default and TopRow' {
|
||||
it 'Default and StartRow' {
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
'Chuck' = 'Jean-Claude'
|
||||
'Norris' = 'Vandamme'
|
||||
'California' = 'Brussels'
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -TopRow 4 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'Default and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -360,18 +384,17 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default, DataOnly and TopRow' {
|
||||
it 'Default, DataOnly and StartRow' {
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
'Chuck' = 'Jean-Claude'
|
||||
'Norris' = 'Vandamme'
|
||||
'California' = 'Brussels'
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 4 | Should BeNullOrEmpty
|
||||
#{Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 4} | Should Throw 'No column headers found'
|
||||
Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'NoHeader' {
|
||||
$ExpectedResult = @(
|
||||
@@ -395,7 +418,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader and TopRow' {
|
||||
it 'NoHeader and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'Chuck'
|
||||
@@ -409,10 +432,10 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 4 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'NoHeader and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -436,7 +459,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader, DataOnly and TopRow' {
|
||||
it 'NoHeader, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'Chuck'
|
||||
@@ -450,10 +473,10 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 4 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'HeaderName' {
|
||||
$ExpectedResult = @(
|
||||
@@ -507,7 +530,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName and TopRow' {
|
||||
it 'HeaderName and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'FirstName' = 'Chuck'
|
||||
@@ -523,7 +546,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -543,10 +566,10 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -TopRow 4 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'HeaderName and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -600,7 +623,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName, DataOnly and TopRow' {
|
||||
it 'HeaderName, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'FirstName' = 'Chuck'
|
||||
@@ -616,7 +639,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -636,26 +659,25 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -DataOnly -TopRow 4 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName FirstName, SecondName, City, Rating, Country -DataOnly -StartRow 4 | Should BeNullOrEmpty
|
||||
}
|
||||
}
|
||||
Describe 'blank rows and columns' {
|
||||
|
||||
#region Create test file
|
||||
<#
|
||||
---------------------------------------------------------------------
|
||||
| A B C D E |
|
||||
|1 Movie name Year Rating Genre |
|
||||
|2 The Bodyguard 1992 9 Thriller |
|
||||
|3 The Matrix 1999 8 Sci-Fi |
|
||||
|4 |
|
||||
|5 Skyfall 2012 9 Thriller |
|
||||
---------------------------------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------
|
||||
# | A B C D E |
|
||||
# |1 Movie name Year Rating Genre |
|
||||
# |2 The Bodyguard 1992 9 Thriller |
|
||||
# |3 The Matrix 1999 8 Sci-Fi |
|
||||
# |4 |
|
||||
# |5 Skyfall 2012 9 Thriller |
|
||||
# ---------------------------------------------------------------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
@@ -713,7 +735,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default and TopRow' {
|
||||
it 'Default and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'The Bodyguard' = 'The Matrix'
|
||||
@@ -735,11 +757,11 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
{Import-Excel -Path $Path -WorksheetName Test -TopRow 4} | Should Throw 'No column headers found'
|
||||
Import-Excel -Path $Path -WorksheetName Test -TopRow 5 | Should BeNullOrEmpty
|
||||
{Import-Excel -Path $Path -WorksheetName Test -StartRow 4} | Should Throw 'No column headers found'
|
||||
Import-Excel -Path $Path -WorksheetName Test -StartRow 5 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'Default and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -766,7 +788,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default, DataOnly and TopRow' {
|
||||
it 'Default, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'The Bodyguard' = 'The Matrix'
|
||||
@@ -782,12 +804,12 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
{Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 4} | Should Throw 'No column headers found'
|
||||
{Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 4} | Should Throw 'No column headers found'
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 5 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 5 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'HeaderName' {
|
||||
$ExpectedResult = @(
|
||||
@@ -867,7 +889,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName and TopRow' {
|
||||
it 'HeaderName and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'MovieName' = 'The Bodyguard'
|
||||
@@ -895,7 +917,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -929,7 +951,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -949,7 +971,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -TopRow 4
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -StartRow 4
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
@@ -960,10 +982,10 @@ Context 'output' {
|
||||
'Country' = 'Thriller'
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -TopRow 5
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -StartRow 5
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -TopRow 6 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -StartRow 6 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'HeaderName and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -1032,7 +1054,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName, DataOnly and TopRow' {
|
||||
it 'HeaderName, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'MovieName' = 'The Bodyguard'
|
||||
@@ -1055,7 +1077,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -1083,7 +1105,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
@@ -1094,13 +1116,13 @@ Context 'output' {
|
||||
'Country' = $null
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -TopRow 4
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -StartRow 4
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -TopRow 5
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -StartRow 5
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -TopRow 6 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -StartRow 6 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'NoHeader' {
|
||||
$ExpectedResult = @(
|
||||
@@ -1144,7 +1166,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader and TopRow' {
|
||||
it 'NoHeader and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'The Bodyguard'
|
||||
@@ -1176,7 +1198,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -1195,7 +1217,7 @@ Context 'output' {
|
||||
'P5' = 'Thriller'
|
||||
}
|
||||
)
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 4
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 4
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
@@ -1206,10 +1228,10 @@ Context 'output' {
|
||||
'P5' = 'Thriller'
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 5
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 5
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 6 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 6 | Should BeNullOrEmpty
|
||||
}
|
||||
it 'NoHeader and DataOnly' {
|
||||
$ExpectedResult = @(
|
||||
@@ -1242,7 +1264,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader, DataOnly and TopRow' {
|
||||
it 'NoHeader, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'The Bodyguard'
|
||||
@@ -1264,7 +1286,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
@@ -1274,30 +1296,29 @@ Context 'output' {
|
||||
'P4' = 'Thriller'
|
||||
}
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 4
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 4
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 5
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 5
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 6 | Should BeNullOrEmpty
|
||||
Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 6 | Should BeNullOrEmpty
|
||||
}
|
||||
}
|
||||
Describe 'blank rows and columns with missing headers' {
|
||||
|
||||
#region Create test file
|
||||
<#
|
||||
---------------------------------------------------------------------------------------------------
|
||||
| A B C D E F G |
|
||||
|1 Movie name Rating Director |
|
||||
|2 The Bodyguard 9 Thriller Mick Jackson |
|
||||
|3 The Matrix 1999 8 Wachowski |
|
||||
|4 |
|
||||
|5 Skyfall 2012 9 Thriller Sam Mendes |
|
||||
|6 10 |
|
||||
---------------------------------------------------------------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------------------------------
|
||||
# | A B C D E F G |
|
||||
# |1 Movie name Rating Director |
|
||||
# |2 The Bodyguard 9 Thriller Mick Jackson |
|
||||
# |3 The Matrix 1999 8 Wachowski |
|
||||
# |4 |
|
||||
# |5 Skyfall 2012 9 Thriller Sam Mendes |
|
||||
# |6 10 |
|
||||
# ---------------------------------------------------------------------------------------------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
@@ -1357,7 +1378,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default and TopRow' {
|
||||
it 'Default and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'The Bodyguard' = 'The Matrix'
|
||||
@@ -1385,7 +1406,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default and DataOnly' {
|
||||
@@ -1415,7 +1436,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'Default, DataOnly and TopRow' {
|
||||
it 'Default, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'The Bodyguard' = 'The Matrix'
|
||||
@@ -1437,7 +1458,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName' {
|
||||
@@ -1531,7 +1552,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName and TopRow' {
|
||||
it 'HeaderName and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'MovieName' = 'The Bodyguard'
|
||||
@@ -1565,7 +1586,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -1606,7 +1627,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName and DataOnly' {
|
||||
@@ -1687,7 +1708,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'HeaderName, DataOnly and TopRow' {
|
||||
it 'HeaderName, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'MovieName' = 'The Bodyguard'
|
||||
@@ -1715,7 +1736,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
|
||||
$ExpectedResult = @(
|
||||
@@ -1749,7 +1770,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -HeaderName MovieName, Year, Rating, Genre, Country -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader' {
|
||||
@@ -1813,7 +1834,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader and TopRow' {
|
||||
it 'NoHeader and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'The Bodyguard'
|
||||
@@ -1862,7 +1883,7 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader and DataOnly' {
|
||||
@@ -1907,7 +1928,7 @@ Context 'output' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'NoHeader, DataOnly and TopRow' {
|
||||
it 'NoHeader, DataOnly and StartRow' {
|
||||
$ExpectedResult = @(
|
||||
[PSCustomObject]@{
|
||||
'P1' = 'The Bodyguard'
|
||||
@@ -1939,27 +1960,27 @@ Context 'output' {
|
||||
}
|
||||
)
|
||||
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -TopRow 2
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -NoHeader -DataOnly -StartRow 2
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#>
|
||||
Context 'special cases' {
|
||||
in $TestDrive {
|
||||
#<#
|
||||
Describe 'duplicate column headers' {
|
||||
it 'worksheet' {
|
||||
#region Create test file
|
||||
<#
|
||||
----------------------------------------------
|
||||
| A B C |
|
||||
|1 First Name first name Address |
|
||||
|2 Chuck Norris California |
|
||||
|3 Jean-Claude Vandamme Brussels |
|
||||
----------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ----------------------------------------------
|
||||
# | A B C |
|
||||
# |1 First Name first name Address |
|
||||
# |2 Chuck Norris California |
|
||||
# |3 Jean-Claude Vandamme Brussels |
|
||||
# ----------------------------------------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
@@ -1983,15 +2004,14 @@ Context 'special cases' {
|
||||
|
||||
#region Create test file
|
||||
Remove-Item .\* -Force
|
||||
<#
|
||||
----------------------------------------------
|
||||
| A B C |
|
||||
|1 |
|
||||
|2 Fruit Fruit Color |
|
||||
|3 Kiwi Green |
|
||||
----------------------------------------------
|
||||
#>
|
||||
|
||||
|
||||
# ----------------------------------------------
|
||||
# | A B C |
|
||||
# |1 |
|
||||
# |2 Fruit Fruit Color |
|
||||
# |3 Kiwi Green |
|
||||
# ----------------------------------------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
@@ -2007,11 +2027,47 @@ Context 'special cases' {
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
|
||||
{Import-Excel -Path $Path -WorksheetName Test -TopRow 2} | Should Throw 'Duplicate column headers found'
|
||||
{Import-Excel -Path $Path -WorksheetName Test -StartRow 2} | Should Throw 'Duplicate column headers found'
|
||||
}
|
||||
it 'HeaderName parameter' {
|
||||
{Import-Excel -Path $Path -WorksheetName Test -HeaderName Apples, Apples, Kiwi} | Should Throw 'Duplicate column headers found'
|
||||
}
|
||||
}
|
||||
#>
|
||||
Describe 'open password protected files' {
|
||||
$Password = 'P@ssw0rd'
|
||||
|
||||
#region Create password protected file
|
||||
|
||||
# ----------------
|
||||
# | A |
|
||||
# |1 Type |
|
||||
# |2 Sensitive |
|
||||
# ----------------
|
||||
|
||||
$Path = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($Path)
|
||||
$Excel = New-Object OfficeOpenXml.ExcelPackage $Path
|
||||
|
||||
# Row, Column
|
||||
$Worksheet = $Excel | Add-WorkSheet -WorkSheetname Test
|
||||
$Worksheet.Cells[1, 1].Value = 'Type'
|
||||
$Worksheet.Cells[2, 1].Value = 'Sensitive'
|
||||
|
||||
$Excel.Save($Password)
|
||||
$Excel.Dispose()
|
||||
#endregion
|
||||
|
||||
it 'password correct' {
|
||||
$Result = Import-Excel -Path $Path -WorksheetName Test -Password $Password
|
||||
|
||||
$ExpectedResult = [PSCustomObject]@{
|
||||
Type = 'Sensitive'
|
||||
}
|
||||
Assert-Equivalent -Actual $Result -Expected $ExpectedResult
|
||||
}
|
||||
it 'password wrong' {
|
||||
{Import-Excel -Path $Path -WorksheetName Test -Password WrongPassword} | Should Throw 'Password'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@
|
||||
RootModule = 'ImportExcel.psm1'
|
||||
|
||||
# Version number of this module.
|
||||
ModuleVersion = '4.0.0'
|
||||
ModuleVersion = '4.0.1'
|
||||
|
||||
# ID used to uniquely identify this module
|
||||
GUID = '60dd4136-feff-401a-ba27-a84458c57ede'
|
||||
|
||||
@@ -75,13 +75,13 @@ Function Import-Excel {
|
||||
|
||||
This switch is best used when you want to import the complete worksheet <20>as is<69> and are not concerned with the property names.
|
||||
|
||||
.PARAMETER TopRow
|
||||
The row from where we start to import data, all rows above the TopRow are disregarded. By default this is the first row.
|
||||
.PARAMETER StartRow
|
||||
The row from where we start to import data, all rows above the StartRow are disregarded. By default this is the first row.
|
||||
|
||||
When the parameters <20>-NoHeader<65> and <20>-HeaderName<6D> are not provided, this row will contain the column headers that will be used as property names. When one of both parameters are provided, the property names are automatically created and this row will be treated as a regular row containing data.
|
||||
|
||||
.EXAMPLE
|
||||
Import data from an Excel worksheet. One object is created for each row. The property names of the objects consist of the column names defined in the first row. In case a column doesn<73>t have a column header (usually in row 1 when <20>-TopRow<EFBFBD> is not used), then the unnamed columns will be skipped and the data in those columns will not be imported.
|
||||
Import data from an Excel worksheet. One object is created for each row. The property names of the objects consist of the column names defined in the first row. In case a column doesn<73>t have a column header (usually in row 1 when <20>-StartRow<EFBFBD> is not used), then the unnamed columns will be skipped and the data in those columns will not be imported.
|
||||
|
||||
----------------------------------------------
|
||||
| File: Movies.xlsx - Sheet: Actors |
|
||||
@@ -208,36 +208,25 @@ Function Import-Excel {
|
||||
|3 Jean-Claude Vandamme Brussels |
|
||||
----------------------------------------------------------
|
||||
|
||||
PS C:\> Import-Excel -Path 'C:\Movies.xlsx' -WorkSheetname Actors -DataOnly -HeaderName 'FirstName', 'SecondName', 'City' <20>TopRow 2
|
||||
PS C:\> Import-Excel -Path 'C:\Movies.xlsx' -WorkSheetname Actors -DataOnly -HeaderName 'FirstName', 'SecondName', 'City' <20>StartRow 2
|
||||
|
||||
FirstName : Jean-Claude
|
||||
SecondName: Vandamme
|
||||
City : Brussels
|
||||
|
||||
Notice that only 1 object is imported with only 3 properties. Column B and row 2 are empty and have been disregarded by using the switch '-DataOnly'. The property names have been named with the values provided with the parameter '-HeaderName'. Row number 1 with <20>Chuck Norris<69> has not been imported, because we started the import from row 2 with the parameter <20>-TopRow 2<>.
|
||||
Notice that only 1 object is imported with only 3 properties. Column B and row 2 are empty and have been disregarded by using the switch '-DataOnly'. The property names have been named with the values provided with the parameter '-HeaderName'. Row number 1 with <20>Chuck Norris<69> has not been imported, because we started the import from row 2 with the parameter <20>-StartRow 2<>.
|
||||
|
||||
.LINK
|
||||
https://github.com/dfinke/ImportExcel
|
||||
|
||||
.NOTES
|
||||
2017/08/16 Added parameter sets for proper parameter validation and to make sure '-NoHeader' and '-HeaderRow' aren't used together
|
||||
Added try/catch clause, CmdLetBinding and verbose messages
|
||||
Renamed 'HeaderRow' to 'TopRow' to avoid confusion with other parameters
|
||||
Renamed '-Header' to '-HeaderName'
|
||||
Added test for duplicate property names
|
||||
Added test for empty worksheet
|
||||
Added test for no data after TopRow
|
||||
Fixed incorrect import when there's no value in the first column
|
||||
Fixed values being imported under the wrong property name in case one
|
||||
Fixed incorrect import in case column A is empty and B and C not ( '$Worksheet.Dimension.Columns' is unreliable because it will say 2 columns are in use while it should say 3).
|
||||
(Ex. Add data in cell B2 and C2, use the '-NoHeader' switch, notice P1 and P2 are incorrectly blanc.)
|
||||
#>
|
||||
|
||||
[CmdLetBinding(DefaultParameterSetName)]
|
||||
Param (
|
||||
[Alias('FullName')]
|
||||
[Parameter(ValueFromPipelineByPropertyName, ValueFromPipeline, Position=0, Mandatory)]
|
||||
[ValidateScript({Test-Path -Path $_ -PathType Leaf})]
|
||||
[ValidateScript({(Test-Path -Path $_ -PathType Leaf) -and ($_ -match '.xls$|.xlsx$')})]
|
||||
[String]$Path,
|
||||
[Alias('Sheet')]
|
||||
[Parameter(Position=1)]
|
||||
@@ -247,10 +236,12 @@ Function Import-Excel {
|
||||
[String[]]$HeaderName,
|
||||
[Parameter(ParameterSetName='C', Mandatory)]
|
||||
[Switch]$NoHeader,
|
||||
[Alias('HeaderRow')]
|
||||
[Alias('HeaderRow','TopRow')]
|
||||
[ValidateRange(1, 9999)]
|
||||
[Int]$TopRow,
|
||||
[Switch]$DataOnly
|
||||
[Int]$StartRow,
|
||||
[Switch]$DataOnly,
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[String]$Password
|
||||
)
|
||||
|
||||
Begin {
|
||||
@@ -285,7 +276,7 @@ Function Import-Excel {
|
||||
[Parameter(Mandatory)]
|
||||
[Int[]]$Columns,
|
||||
[Parameter(Mandatory)]
|
||||
[Int]$TopRow
|
||||
[Int]$StartRow
|
||||
)
|
||||
|
||||
Try {
|
||||
@@ -304,12 +295,12 @@ Function Import-Excel {
|
||||
}
|
||||
}
|
||||
else {
|
||||
if ($TopRow -eq 0) {
|
||||
if ($StartRow -eq 0) {
|
||||
throw 'The top row can never be equal to 0 when we need to retrieve headers from the worksheet.'
|
||||
}
|
||||
|
||||
foreach ($C in $Columns) {
|
||||
$Worksheet.Cells[$TopRow,$C] | where {$_.Value} | Select-Object @{N='Column'; E={$C}}, Value
|
||||
$Worksheet.Cells[$StartRow,$C] | where {$_.Value} | Select-Object @{N='Column'; E={$C}}, Value
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -321,11 +312,26 @@ Function Import-Excel {
|
||||
|
||||
Process {
|
||||
Try {
|
||||
#region Open file
|
||||
$Path = (Resolve-Path $Path).ProviderPath
|
||||
Write-Verbose "Import Excel workbook '$Path' with worksheet '$Worksheetname'"
|
||||
|
||||
$Stream = New-Object -TypeName System.IO.FileStream -ArgumentList $Path, 'Open', 'Read', 'ReadWrite'
|
||||
$Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Stream
|
||||
|
||||
if ($Password) {
|
||||
$Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage
|
||||
|
||||
Try {
|
||||
$Excel.Load($Stream,$Password)
|
||||
}
|
||||
Catch {
|
||||
throw "Password '$Password' is not correct."
|
||||
}
|
||||
}
|
||||
else {
|
||||
$Excel = New-Object -TypeName OfficeOpenXml.ExcelPackage -ArgumentList $Stream
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Select worksheet
|
||||
if ($WorksheetName) {
|
||||
@@ -339,13 +345,13 @@ Function Import-Excel {
|
||||
#endregion
|
||||
|
||||
#region Set the top row
|
||||
if (((-not ($NoHeader -or $HeaderName)) -and ($TopRow -eq 0))) {
|
||||
$TopRow = 1
|
||||
if (((-not ($NoHeader -or $HeaderName)) -and ($StartRow -eq 0))) {
|
||||
$StartRow = 1
|
||||
}
|
||||
#endregion
|
||||
|
||||
if (-not ($AllCells = $Worksheet.Cells | where {($_.Start.Row -ge $TopRow)})) {
|
||||
Write-Warning "Worksheet '$WorksheetName' in workbook '$Path' is empty after TopRow '$TopRow'"
|
||||
if (-not ($AllCells = $Worksheet.Cells | where {($_.Start.Row -ge $StartRow)})) {
|
||||
Write-Warning "Worksheet '$WorksheetName' in workbook '$Path' is empty after StartRow '$StartRow'"
|
||||
}
|
||||
else {
|
||||
#region Get rows and columns
|
||||
@@ -360,17 +366,17 @@ Function Import-Excel {
|
||||
$Columns = 1..$LastColumn
|
||||
|
||||
$LastRow = $AllCells.Start.Row | Sort-Object -Unique | Select-Object -Last 1
|
||||
$Rows = $TopRow..$LastRow | where {($_ -ge $TopRow) -and ($_ -gt 0)}
|
||||
$Rows = $StartRow..$LastRow | where {($_ -ge $StartRow) -and ($_ -gt 0)}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Create property names
|
||||
if ((-not $Columns) -or (-not ($PropertyNames = Get-PropertyNames -Columns $Columns -TopRow $TopRow))) {
|
||||
throw "No column headers found on top row '$TopRow'. If column headers in the worksheet are not a requirement then please use the '-NoHeader' or '-HeaderName' parameter."
|
||||
if ((-not $Columns) -or (-not ($PropertyNames = Get-PropertyNames -Columns $Columns -StartRow $StartRow))) {
|
||||
throw "No column headers found on top row '$StartRow'. If column headers in the worksheet are not a requirement then please use the '-NoHeader' or '-HeaderName' parameter."
|
||||
}
|
||||
|
||||
if ($Duplicates = $PropertyNames | Group-Object Value | where Count -GE 2) {
|
||||
throw "Duplicate column headers found on row '$TopRow' in columns '$($Duplicates.Group.Column)'. Column headers must be unique, if this is not a requirement please use the '-NoHeader' or '-HeaderName' parameter."
|
||||
throw "Duplicate column headers found on row '$StartRow' in columns '$($Duplicates.Group.Column)'. Column headers must be unique, if this is not a requirement please use the '-NoHeader' or '-HeaderName' parameter."
|
||||
}
|
||||
#endregion
|
||||
|
||||
@@ -383,12 +389,12 @@ Function Import-Excel {
|
||||
|
||||
#region Filter out the top row when it contains column headers
|
||||
if (-not ($NoHeader -or $HeaderName)) {
|
||||
$Rows = $Rows | where {$_ -gt $TopRow}
|
||||
$Rows = $Rows | where {$_ -gt $StartRow}
|
||||
}
|
||||
#endregion
|
||||
|
||||
if (-not $Rows) {
|
||||
Write-Warning "Worksheet '$WorksheetName' in workbook '$Path' contains no data in the rows after top row '$TopRow'"
|
||||
Write-Warning "Worksheet '$WorksheetName' in workbook '$Path' contains no data in the rows after top row '$StartRow'"
|
||||
}
|
||||
else {
|
||||
#region Create one object per row
|
||||
|
||||
13
README.md
13
README.md
@@ -27,15 +27,22 @@ iex (new-object System.Net.WebClient).DownloadString('https://raw.github.com/dfi
|
||||
```
|
||||
|
||||
# What's new
|
||||
#### 9/12/2017
|
||||
Version 4.0 released.
|
||||
#### 9/28/2017 (Version 4.0.1)
|
||||
- Added a new parameter called `Password` to import password protected files
|
||||
- Added even more `Pester` tests for a more robust and bug free module
|
||||
- Renamed parameter 'TopRow' to 'StartRow'
|
||||
This allows us to be more concise when new parameters ('StartColumn', ..) will be added in the future Your code will not break after the update, because we added an alias for backward compatibility
|
||||
|
||||
Special thanks to [robinmalik](https://github.com/robinmalik) for providing us with [the code](https://github.com/dfinke/ImportExcel/issues/174) to implement this new feature. A high five to [DarkLite1](https://github.com/DarkLite1) for the implementation.
|
||||
|
||||
#### 9/12/2017 (Version 4.0)
|
||||
|
||||
Super thanks and hat tip to [DarkLite1](https://github.com/DarkLite1). There is now a new and improved `Import-Excel`, not only in functionality, but also improved readability, examples and more. Not only that, he's been running it in production in his company for a number of weeks!
|
||||
|
||||
*Added* `Update-FirstObjectProperties` Updates the first object to contain all the properties of the object with the most properties in the array. Check out the help.
|
||||
|
||||
|
||||
***Breaking Changes***: Due to a big portion of the code that is rewritten some slightly different behaviour can be expected from the `Import-Excel` function. This is especially true for importing empty Excel files with or without using the `TopRow` parameter. To make sure that your code is still valid, please check the examples in the help or the accompanying `Pester` test file.
|
||||
***Breaking Changes***: Due to a big portion of the code that is rewritten some slightly different behavior can be expected from the `Import-Excel` function. This is especially true for importing empty Excel files with or without using the `TopRow` parameter. To make sure that your code is still valid, please check the examples in the help or the accompanying `Pester` test file.
|
||||
|
||||
|
||||
Moving forward, we are planning to include automatic testing with the help of `Pester`, `Appveyor` and `Travis`. From now on any changes in the module will have to be accompanied by the corresponding `Pester` tests to avoid breakages of code and functionality. This is in preparation for new features coming down the road.
|
||||
|
||||
Reference in New Issue
Block a user