Document bug with Microsoft SQL Server 2017 Reporting Services

Author: johlju

source/Classes/020.SqlRSSetup.ps1

@@ -105,6 +105,14 @@
         installed or not. Due to this limitation the property is evaluated in
         the AssertProperties() method to have one of the valid values.
 
+        Known issues:
+        - Using `VersionUpgrade` with Microsoft SQL Server 2017 Reporting Services
+          does not work because that version does not set a product version in the
+          registry. So there is nothing to compare against the setup executable
+          product version. It does set a current version, but that does not correlate
+          to the product version. This apparently by design with Microsoft SQL Server
+          2017 Reporting Services.
+
     .EXAMPLE
         Configuration Example
         {
@@ -342,15 +350,7 @@ class SqlRSSetup : ResourceBase
             $currentState.InstanceName = $rsConfiguration.InstanceName
             $currentState.InstallFolder = $rsConfiguration.InstallFolder
 
-            if ([System.String]::IsNullOrEmpty($rsConfiguration.ProductVersion))
-            {
-                Write-Verbose -Message (
-                    $this.localizedData.MissingProductVersionUsingCurrentVersion -f $properties.InstanceName, $rsConfiguration.CurrentVersion
-                )
-
-                $currentState.ProductVersion = $rsConfiguration.CurrentVersion
-            }
-            else
+            if (-not ([System.String]::IsNullOrEmpty($rsConfiguration.ProductVersion)))
             {
                 $currentState.ProductVersion = $rsConfiguration.ProductVersion
             }

source/en-US/SqlRSSetup.strings.psd1

@@ -29,5 +29,4 @@ ConvertFrom-StringData @'
     NotDesiredProductVersion = The product version '{0}' is not the desired for the instance '{1}'. Desired version in executable: '{2}'.
     InstanceName_Invalid = The instance name '{0}' is invalid. Only one of the supported instance name can be used, either SSRS or PBIRS depending on what setup executable is used.
     CannotDetermineProductVersion = Could not determine the product version for the installed instance '{0}'. Run the command `Get-SqlDscRSSetupConfiguration -InstanceName '{0}'` to get the configuration for the instance and verify that it returns a valid product version.
-    MissingProductVersionUsingCurrentVersion = The product version for the instance '{0}' is missing. Returning the current version '{1}' instead.
 '@

tests/Integration/Resources/DSC_SqlRSSetup.config.ps1

@@ -63,8 +63,19 @@ Configuration DSC_SqlRSSetup_InstallReportingServicesAsUser_Config
             InstallFolder        = $Node.InstallFolder
             LogPath              = $Node.LogPath
 
-            # The build worker contains already an instance, make sure to upgrade it.
-            VersionUpgrade       = $true
+            <#
+                The build worker contains already an instance, make sure to upgrade it.
+                It does not work for Microsoft SQL Server 2017 Reporting Services,
+                see .NOTES section in the resource.
+            #>
+            VersionUpgrade       = if ($env:Integration_SQL2017)
+            {
+                $false
+            }
+            else
+            {
+                $true
+            }
 
             # Suppressing restart because the build worker are not allowed to be restarted.
             SuppressRestart      = $true