Cleaned up tests

sanderstad · sanderstad · commit 646ae8d9c6bc · 2018-07-04T18:39:34.000+02:00
diff --git a/en-us/about_PSDatabaseClone.help.txt b/en-us/about_PSDatabaseClone.help.txt
diff --git a/functions/Initialize-PDCVhdDisk.ps1 b/functions/Initialize-PDCVhdDisk.ps1
@@ -15,6 +15,13 @@ function Initialize-PDCVhdDisk {
 
     $scred = Get-Credential, then pass $scred object to the -Credential parameter.
 
+.PARAMETER PartitionStyle
+    A partition can either be initialized as MBR or as GPT. GPT is the default.
+
+.PARAMETER AllocationUnitSize
+    Set the allocation unit size for the disk.
+    By default it's 64 KB because that's what SQL Server tends to write most of the time.
+
 .PARAMETER EnableException
     By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
     This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
diff --git a/functions/Invoke-PDCRepairClone.ps1 b/functions/Invoke-PDCRepairClone.ps1
@@ -107,18 +107,13 @@ function Invoke-PDCRepairClone {
             # Loop through the results
             foreach ($result in $results) {
 
-                $disk = $null
-
                 # Get the databases
                 Write-PSFMessage -Message "Retrieve the databases for $($result.SqlInstance)" -Level Verbose
                 $databases = Get-DbaDatabase -SqlInstance $result.SqlInstance -SqlCredential $SqlCredential
 
                 # Check if the parent of the clone can be reached
                 if (Test-Path -Path $result.ImageLocation) {
 
-                    # Get the disk
-                    $disk = Get-VHD -Path $result.CloneLocation
-
                     # Mount the clone
                     try {
                         Write-PSFMessage -Message "Mounting vhd $($result.CloneLocation)" -Level Verbose
diff --git a/functions/New-PDCClone.ps1 b/functions/New-PDCClone.ps1
@@ -35,6 +35,9 @@ function New-PDCClone {
 .PARAMETER Database
     Database name for the clone
 
+.PARAMETER LatestImage
+    Automatically get the last image ever created for an specific database
+
 .PARAMETER Disabled
     Registers the clone in the configuration as disabled.
     If this setting is used the clone will not be recovered when the repair command is run
@@ -78,7 +81,7 @@ function New-PDCClone {
 
     Create a new clone on SQLDB1 and SQLDB2 for the databases DB1 with the latest image
 #>
-    [CmdLetBinding(DefaultParameterSetName = 'ByLatest')]
+    [CmdLetBinding(DefaultParameterSetName = 'ByLatest', SupportsShouldProcess = $true)]
     param(
         [parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
@@ -213,7 +216,7 @@ function New-PDCClone {
                         $result = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query -EnableException
 
                         # Check the results
-                        if ($result -eq $null) {
+                        if ($null -eq $result) {
                             Stop-PSFFunction -Message "No image could be found for database $db" -Target $pdcSqlInstance -Continue
                         }
                         else {
@@ -405,7 +408,7 @@ function New-PDCClone {
                 }
 
 
-                if ($imageId -ne $null) {
+                if ($null -ne $imageId) {
 
                     $cloneLocation = "$Destination\$CloneName.vhdx"
 
diff --git a/functions/New-PDCImage.ps1 b/functions/New-PDCImage.ps1
@@ -39,7 +39,7 @@ function New-PDCImage {
 
     $scred = Get-Credential, then pass $scred object to the -DestinationCredential parameter.
 
-.PARAMETER ImageLocalPath
+.PARAMETER ImageNetworkPath
     Network path where to save the image. This has to be a UNC path
 
 .PARAMETER ImageLocalPath
@@ -89,7 +89,7 @@ function New-PDCImage {
     Create an image from the database DB1 on SQLDB1 using the last full backup and use SQLDB2 as the temporary database server.
     The image is written to c:\Temp\images
 #>
-    [CmdLetBinding()]
+    [CmdLetBinding(SupportsShouldProcess = $true)]
     param(
         [parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
@@ -212,8 +212,6 @@ function New-PDCImage {
         # Set time stamp
         $timestamp = Get-Date -format "yyyyMMddHHmmss"
 
-        # Create the item list array
-        $list = @()
     }
 
     process {
@@ -401,30 +399,6 @@ function New-PDCImage {
                 Stop-PSFFunction -Message "Couldn't add image to database" -Target $imageName -ErrorRecord $_
             }
 
-            <# if (Test-PSFFunctionInterrupt) {
-                Write-PSFMessage -Message "Cleaning up image after failure" -Level Verbose
-
-                # Clean up in case of failure
-                try {
-                    # Check if the image was written to database
-                    if ($result.Count -ge 1) {
-
-                        $query = "DELETE FROM Image WHERE ImageID = $($Result.ImageID)"
-
-                        $null = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query -EnableException
-                    }
-
-                    # Remove file
-                    $null = Remove-Item -Path $imageLocation -Credential $DestinationCredential -Force:$Force
-                }
-                catch {
-                    Stop-PSFFunction -Message "Couldn't remove created image $imageLocation after failure" -Target $imageLocation -ErrorRecord $_ -Continue
-                }
-            }
-            else {
-
-            } #>
-
             # Add the results to the custom object
             [PSCustomObject]@{
                 Name      = $imageName
diff --git a/functions/New-PDCVhdDisk.ps1 b/functions/New-PDCVhdDisk.ps1
@@ -56,7 +56,7 @@ function New-PDCVhdDisk {
 
 #>
 
-    [CmdLetBinding()]
+    [CmdLetBinding(SupportsShouldProcess = $true)]
 
     param(
         [parameter(Mandatory = $true)]
diff --git a/functions/Remove-PDCClone.ps1 b/functions/Remove-PDCClone.ps1
@@ -34,6 +34,12 @@ function Remove-PDCClone {
 .PARAMETER ExcludeDatabase
     Allows to filter to exclude specific databases
 
+.PARAMETER All
+    Remove all the clones
+
+.PARAMETER InputObject
+    The input object that is used for pipeline use
+
 .PARAMETER EnableException
     By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
     This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
diff --git a/functions/Remove-PDCImage.ps1 b/functions/Remove-PDCImage.ps1
@@ -18,6 +18,17 @@ function Remove-PDCImage {
 .PARAMETER Force
     Forcefully remove the items.
 
+.PARAMETER EnableException
+    By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
+    This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
+    Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
+
+.PARAMETER WhatIf
+    If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
+
+.PARAMETER Confirm
+    If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
+
 .NOTES
     Author: Sander Stad (@sqlstad, sqlstad.nl)
 
@@ -28,8 +39,12 @@ function Remove-PDCImage {
 .LINK
     https://psdatabaseclone.io/
 
+.EXAMPLE
+    Remove-PDCImage -ImageLocation "\\server1\images\DB1_20180703193345.vhdx"
+
+    Remove an image
 #>
-    [CmdLetBinding()]
+    [CmdLetBinding(SupportsShouldProcess = $true)]
 
     param(
         [parameter(Mandatory = $true)]
diff --git a/functions/Set-PDCConfiguration.ps1 b/functions/Set-PDCConfiguration.ps1
@@ -53,7 +53,7 @@ function Set-PDCConfiguration {
 
     Set up the module to use SQLDB1 as the database servers and PSDatabaseClone to save the values in
 #>
-    [CmdLetBinding()]
+    [CmdLetBinding(SupportsShouldProcess = $true)]
     param(
         [parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
diff --git a/internal/functions/Convert-PDCLocalUncPathToLocalPath.ps1 b/internal/functions/Convert-PDCLocalUncPathToLocalPath.ps1
@@ -32,7 +32,10 @@ function Convert-PDCLocalUncPathToLocalPath {
     https://psdatabaseclone.io/
 
 .EXAMPLE
-    Convert-PDCLocalUncPathToLocalPath -UncPath "\\server\share"
+    Convert-PDCLocalUncPathToLocalPath -UncPath "\\server1\share1"
+
+    Convert path "\\server1\share1" to a local path from server1
+
 
 #>
 
diff --git a/internal/functions/Test-PDCConfiguration.ps1 b/internal/functions/Test-PDCConfiguration.ps1
@@ -41,6 +41,17 @@ function Test-PDCConfiguration {
 
 .LINK
     https://psdatabaseclone.io/
+
+.EXAMPLE
+    Test-PDCConfiguration
+
+    Test the configuration of the module retrieving the set configurations
+
+.EXAMPLE
+    Test-PDCConfiguration -SqlInstance SQLDB1 -Database PSDatabaseClone
+
+    Test the configuration with the instance and database set
+
 #>
 
     [CmdLetBinding()]
@@ -56,7 +67,7 @@ function Test-PDCConfiguration {
     Write-PSFMessage -Message "SqlInstance: $SqlInstance, Database: $Database" -Level Debug
 
     # Check if the values for the PSDatabaseClone database are set
-    if (($SqlInstance -eq $null) -or ($Database -eq $null)) {
+    if (($null -eq $SqlInstance) -or ($null -eq $Database)) {
         # Get the configurations for the program database
         $Database = Get-PSFConfigValue -FullName psdatabaseclone.database.name -Fallback "NotConfigured"
         $SqlInstance = Get-PSFConfigValue -FullName psdatabaseclone.database.Server -Fallback "NotConfigured"
diff --git a/tests/constants.ps1 b/tests/constants.ps1
@@ -0,0 +1,17 @@
+# constants
+if (Test-Path C:\temp\constants.ps1) {
+    Write-Verbose "C:\temp\constants.ps1 found."
+    . C:\temp\constants.ps1
+}
+elseif (Test-Path "$PSScriptRoot\constants.local.ps1") {
+    Write-Verbose "tests\constants.local.ps1 found."
+    . "$PSScriptRoot\constants.local.ps1"
+}
+else {
+    $script:instance1 = "localhost\sql2008r2sp2"
+    $script:instance2 = "localhost\sql2016"
+    $script:instance3 = "localhost\sql2017"
+    $script:instance1_detailed = "localhost,1433\sql2008r2sp2" #Just to make sure things parse a port properly
+    $script:appveyorlabrepo = "C:\github\appveyor-lab"
+    $instances = @($script:instance1, $script:instance2)
+}
diff --git a/tests/functions/New-PDCVhdDisk.Tests.ps1 b/tests/functions/New-PDCVhdDisk.Tests.ps1
@@ -0,0 +1,41 @@
+$commandname = $MyInvocation.MyCommand.Name.Replace(".Tests.ps1", "")
+$rootPath = Split-Path (Split-Path $PSScriptRoot -Parent) -Parent
+
+Write-Host -Object "Running $PSCommandpath" -ForegroundColor Cyan
+
+. "$rootPath\tests\constants.ps1"
+
+Describe "$commandname Unit Tests" {
+
+    BeforeAll {
+        # Get a random value for the database name
+        $random = Get-Random
+
+        $filename = "Test_VHD_$($random).vhdx"
+        $name = "Test_VHD_$($random)"
+        $destination = "$rootPath\tests"
+        $path = "$destination\$filename"
+    }
+
+    Context "Create VHD with file name" {
+        It -Skip "Should be successful" {
+            $null = New-PDCVhdDisk -Destination $destination -FileName "$name.vhdx"
+
+            (Test-Path -Path $path) | Should -Be $true
+        }
+
+        Remove-Item -Path $path -Force
+    }
+
+    Context "Create VHD with name" {
+        It -Skip "Should be successful" {
+            $null = New-PDCVhdDisk -Destination $destination -Name $name
+
+            (Test-Path -Path $path) | Should -Be $true
+
+        }
+
+        Remove-Item -Path $path -Force
+    }
+
+}
diff --git a/tests/general/Manifest.Tests.ps1 b/tests/general/Manifest.Tests.ps1
@@ -1,43 +1,43 @@
 Describe "Validating the module manifest" {
 	$moduleRoot = (Resolve-Path "$PSScriptRoot\..\..").Path
-	$manifest = ((Get-Content "$moduleRoot\PSDatabasClone.psd1") -join "`n") | Invoke-Expression
-	[version]$moduleVersion = Get-Item "$moduleRoot\PSDatabasClone.psm1" | Select-String -Pattern '\$script:PSModuleVersion = "(.*?)"' | ForEach-Object { $_.Matches[0].Groups[1].Value }
+	$manifest = ((Get-Content "$moduleRoot\PSDatabaseClone.psd1") -join "`n") | Invoke-Expression
+	[version]$moduleVersion = Get-Item "$moduleRoot\PSDatabaseClone.psm1" | Select-String -Pattern '\$script:PSModuleVersion = "(.*?)"' | ForEach-Object { $_.Matches[0].Groups[1].Value }
 	Context "Basic resources validation" {
 		It "Exports all functions in the public folder" {
 			$files = Get-ChildItem "$moduleRoot\functions" -Recurse -File -Filter "*.ps1"
 			$count = (Compare-Object -ReferenceObject $files.BaseName -DifferenceObject $manifest.FunctionsToExport).Count
 			$count | Should be 0
 		}
-		
+
 		It "Exports none of its internal functions" {
 			$files = Get-ChildItem "$moduleRoot\internal\functions" -Recurse -File -Filter "*.ps1"
 			$files | Where-Object BaseName -In $manifest.FunctionsToExport | Should Be $null
 		}
-		
+
 		It "Has the same version as the psm1 file" {
 			([version]$manifest.ModuleVersion) | Should Be $moduleVersion
 		}
 	}
-	
+
 	Context "Individual file validation" {
 		It "The root module file exists" {
 			Test-Path "$moduleRoot\$($manifest.RootModule)" | Should Be $true
 		}
-		
+
 		foreach ($format in $manifest.FormatsToProcess)
 		{
 			It "The file $format should exist" {
 				Test-Path "$moduleRoot\$format" | Should Be $true
 			}
 		}
-		
+
 		foreach ($type in $manifest.TypesToProcess)
 		{
 			It "The file $type should exist" {
 				Test-Path "$moduleRoot\$type" | Should Be $true
 			}
 		}
-		
+
 		foreach ($assembly in $manifest.RequiredAssemblies)
 		{
 			It "The file $assembly should exist" {
diff --git a/tests/pester.ps1 b/tests/pester.ps1
@@ -13,9 +13,9 @@ if ($env:BUILD_BUILDURI -like "vstfs*")
 
 Write-PSFMessage -Level Important -Message "Importing Module"
 
-Remove-Module PSDatabasClone -ErrorAction Ignore
-Import-Module "$PSScriptRoot\..\PSDatabasClone.psd1"
-Import-Module "$PSScriptRoot\..\PSDatabasClone.psm1" -Force
+Remove-Module PSDatabaseClone -ErrorAction Ignore
+Import-Module "$PSScriptRoot\..\PSDatabaseClone.psd1"
+Import-Module "$PSScriptRoot\..\PSDatabaseClone.psm1" -Force
 
 $totalFailed = 0
 $totalRun = 0
diff --git a/xml/PSDatabaseClone.Format.ps1xml b/xml/PSDatabaseClone.Format.ps1xml
diff --git a/xml/PSDatabaseClone.Types.ps1xml b/xml/PSDatabaseClone.Types.ps1xml
