Assert-SetupActionProperties: Refactor to use Get-FileVersion (#2374)

Author: johlju

CHANGELOG.md

@@ -41,6 +41,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- `Assert-SetupActionProperties`
+  - Refactored to use the command `Get-FileVersion` from the DscResource.Common
+    module instead of the private function `Get-FileVersionInformation`
+    ([issue #2373](https://github.com/dsccommunity/SqlServerDsc/issues/2373)).
 - Renamed commands `*-SqlDscBIReportServer` to `*-SqlDscPowerBIReportServer` for
   clarity. The old names `*-SqlDscBIReportServer` and `*-SqlDscPBIReportServer`
   are available as aliases for backward compatibility
@@ -117,6 +121,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed private function `Get-FileVersionInformation`. Use the command
+  `Get-FileVersion` from the DscResource.Common module instead
+  ([issue #2373](https://github.com/dsccommunity/SqlServerDsc/issues/2373)).
 - Removed deprecated private function `Get-ProtocolNameProperties` from the
   SqlServerDsc.Common module. Use the public command `Get-SqlDscServerProtocolName`
   instead ([issue #2104](https://github.com/dsccommunity/SqlServerDsc/issues/2104)).

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1

@@ -1991,7 +1991,7 @@ function ConvertTo-ServerInstanceName
 
     .NOTES
         This function should be removed when it is not longer used, and instead
-        the private function Get-FileVersionInformation shall be used.
+        the command Get-FileVersion from the DscResource.Common module shall be used.
 #>
 function Get-FilePathMajorVersion
 {

source/Private/Assert-SetupActionProperties.ps1

@@ -46,7 +46,7 @@ function Assert-SetupActionProperties
     {
         $setupExecutableFileVersion = $Property.MediaPath |
             Join-Path -ChildPath 'setup.exe' |
-            Get-FileVersionInformation
+            Get-FileVersion
 
         $Property.Features |
             Assert-Feature -ProductVersion $setupExecutableFileVersion.ProductVersion

source/Private/Get-FileVersionInformation.ps1

@@ -249,9 +249,6 @@ ConvertFrom-StringData @'
     ## Assert-Feature
     Feature_Assert_NotSupportedFeature = The feature '{0}' is not supported for Microsoft SQL Server product version {1}. See the Microsoft SQL Server documentation https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server-from-the-command-prompt#Feature for more information.
 
-    ## Get-FileVersionInformation
-    FileVersionInformation_Get_FilePathIsNotFile = The specified path is not a file.
-
     ## Get-SqlDscConfigurationOption
     ConfigurationOption_Get_Missing = There is no configuration option with the name '{0}'.
 

source/en-US/SqlServerDsc.strings.psd1

@@ -388,9 +388,9 @@ Describe 'Assert-SetupActionProperties' -Tag 'Private' {
             Mock -CommandName Assert-Feature
 
             # Required mock for mocking Assert-Feature above.
-            Mock -CommandName Get-FileVersionInformation -MockWith {
-                return @{
-                    ProductVersion = 16
+            Mock -CommandName Get-FileVersion -MockWith {
+                return [PSCustomObject] @{
+                    ProductVersion = '16.0.1000.6'
                 }
             }
         }
@@ -522,9 +522,9 @@ Describe 'Assert-SetupActionProperties' -Tag 'Private' {
             Mock -CommandName Assert-Feature
 
             # Required mock for mocking Assert-Feature above.
-            Mock -CommandName Get-FileVersionInformation -MockWith {
-                return @{
-                    ProductVersion = 16
+            Mock -CommandName Get-FileVersion -MockWith {
+                return [PSCustomObject] @{
+                    ProductVersion = '16.0.1000.6'
                 }
             }
         }