Refactor module name usage in tests and remove unnecessary -Force flag from Import-Module

Author: johlju

tests/Unit/Classes/SqlDatabase.Tests.ps1

@@ -30,11 +30,13 @@ BeforeDiscovery {
 }
 
 BeforeAll {
-    $script:dscModuleName = 'SqlServerDsc'
+    $script:moduleName = 'SqlServerDsc'
 
     $env:SqlServerDscCI = $true
 
-    Import-Module -Name $script:dscModuleName -Force -ErrorAction 'Stop'
+    # Do not use -Force. Doing so, or unloading the module in AfterAll, causes
+    # PowerShell class types to get new identities, breaking type comparisons.
+    Import-Module -Name $script:moduleName -ErrorAction 'Stop'
 
     Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '../../TestHelpers/CommonTestHelper.psm1')
 
@@ -44,19 +46,16 @@ BeforeAll {
     # Load the correct SQL Module stub
     $script:stubModuleName = Import-SQLModuleStub -PassThru
 
-    $PSDefaultParameterValues['InModuleScope:ModuleName'] = $script:dscModuleName
-    $PSDefaultParameterValues['Mock:ModuleName'] = $script:dscModuleName
-    $PSDefaultParameterValues['Should:ModuleName'] = $script:dscModuleName
+    $PSDefaultParameterValues['InModuleScope:ModuleName'] = $script:moduleName
+    $PSDefaultParameterValues['Mock:ModuleName'] = $script:moduleName
+    $PSDefaultParameterValues['Should:ModuleName'] = $script:moduleName
 }
 
 AfterAll {
     $PSDefaultParameterValues.Remove('InModuleScope:ModuleName')
     $PSDefaultParameterValues.Remove('Mock:ModuleName')
     $PSDefaultParameterValues.Remove('Should:ModuleName')
 
-    # Unload the module being tested so that it doesn't impact any other tests.
-    Get-Module -Name $script:dscModuleName -All | Remove-Module -Force
-
     # Unload the stub module.
     Remove-SqlModuleStub -Name $script:stubModuleName
 

tests/Unit/Public/New-SqlDscDatabaseSnapshot.Tests.ps1

@@ -1,21 +1,6 @@
 [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
 param ()
 
-<#
-    TODO: This fails with:
-
-    Running tests from 'D:\a\1\s\tests\Unit\Public\New-SqlDscDatabaseSnapshot.Tests.ps1'
-    Describing New-SqlDscDatabaseSnapshot
-    Context When creating a database snapshot using ServerObject parameter set
-    ##[error]    [-] Should create a database snapshot successfully with minimal parameters 28ms (25ms|3ms)
-    ##[error]     PSInvalidCastException: Cannot convert the "DatabaseFileSpec" value of type "DatabaseFileSpec" to type "DatabaseFileSpec".
-    ##[error]     ArgumentTransformationMetadataException: Cannot convert the "DatabaseFileSpec" value of type "DatabaseFileSpec" to type "DatabaseFileSpec".
-    ##[error]     ParameterBindingArgumentTransformationException: Cannot process argument transformation on parameter 'Files'. Cannot convert the "DatabaseFileSpec" value of type "DatabaseFileSpec" to type "DatabaseFileSpec".
-    ##[error]     at New-SqlDscDatabaseSnapshot<Process>, D:\a\1\s\output\builtModule\SqlServerDsc\17.4.0\SqlServerDsc.psm1:20649
-    ##[error]     at <ScriptBlock>, D:\a\1\s\tests\Unit\Public\New-SqlDscDatabaseSnapshot.Tests.ps1:137
-#>
-return
-
 BeforeDiscovery {
     try
     {