Fix review comments

johlju · johlju · commit 67aa46bb2f68 · 2025-04-30T17:31:20.000+02:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -75,7 +75,9 @@
         "fastbuild",
         "CODEOWNERS",
         "analyzersettings",
-        "sqlcmd"
+        "sqlcmd",
+        "PBIRS",
+        "SSRS"
     ],
     "cSpell.ignorePaths": [
         ".git"
diff --git a/source/Classes/020.SqlRSSetup.ps1 b/source/Classes/020.SqlRSSetup.ps1
@@ -162,7 +162,6 @@
 [DscResource(RunAsCredential = 'Optional')]
 class SqlRSSetup : ResourceBase
 {
-    # cSpell:ignore SSRS PBIRS
     [DscProperty(Key)]
     [System.String]
     $InstanceName
diff --git a/source/en-US/SqlRSSetup.strings.psd1 b/source/en-US/SqlRSSetup.strings.psd1
@@ -4,31 +4,31 @@
         resource SqlRSSetup.
 #>
 
-# cSpell:ignore SSRS PBIRS
+# cSpell:ignore SRSS
 ConvertFrom-StringData @'
     ## Strings overrides for the ResourceBase's default strings.
     # None
 
-    ## Strings directly used by the derived class SqlRSSetup.
-    Getting_Information_Instance = Getting information about instance '{0}'.
-    Instance_NotInstalled = Instance '{0}' is not installed.
-    Instance_Installed = Instance '{0}' is installed.
-    AcceptLicensingTerms_Required = AcceptLicensingTerms must be set for Install and Repair operations.
-    MediaPath_Invalid = The media path '{0}' does not exist.
-    MediaPath_DoesNotHaveRequiredExtension = The media path '{0}' does not reference an executable with the required extension .exe.
-    EditionOrProductKeyMissing = Neither the parameters Edition or ProductKey was specified.
-    EditionUpgrade_RequiresKeyOrEdition = EditionUpgrade requires either ProductKey or Edition to be specified.
-    LogPath_ParentMissing = The parent directory '{0}' for LogPath does not exist.
-    InstallFolder_ParentMissing = The parent directory '{0}' for InstallFolder does not exist.
-    Installing_ReportingServices = Installing SQL Server Reporting Services.
-    Installing_PowerBIReportServer = Installing Power BI Report Server.
-    Repairing_ReportingServices = Repairing SQL Server Reporting Services.
-    Repairing_PowerBIReportServer = Repairing Power BI Report Server.
-    Uninstalling_ReportingServices = Uninstalling SQL Server Reporting Services.
-    Uninstalling_PowerBIReportServer = Uninstalling Power BI Report Server.
-    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.
-    CannotDetermineEdition = Could not determine the edition 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 edition.
-    NotDesiredEdition = The edition '{0}' is not the desired for the instance '{1}'. Desired edition in executable: '{2}'.
+    ## Strings directly used by the derived class SqlRSSetup. (SRSS0001)
+    Getting_Information_Instance = Getting information about instance '{0}'. (SRSS0002)
+    Instance_NotInstalled = Instance '{0}' is not installed. (SRSS0003)
+    Instance_Installed = Instance '{0}' is installed. (SRSS0004)
+    AcceptLicensingTerms_Required = AcceptLicensingTerms must be set for Install and Repair operations. (SRSS0005)
+    MediaPath_Invalid = The media path '{0}' does not exist. (SRSS0006)
+    MediaPath_DoesNotHaveRequiredExtension = The media path '{0}' does not reference an executable with the required extension .exe. (SRSS0007)
+    EditionOrProductKeyMissing = Neither the parameters Edition or ProductKey was specified. (SRSS0008)
+    EditionUpgrade_RequiresKeyOrEdition = EditionUpgrade requires either ProductKey or Edition to be specified. (SRSS0009)
+    LogPath_ParentMissing = The parent directory '{0}' for LogPath does not exist. (SRSS0010)
+    InstallFolder_ParentMissing = The parent directory '{0}' for InstallFolder does not exist. (SRSS0011)
+    Installing_ReportingServices = Installing SQL Server Reporting Services. (SRSS0012)
+    Installing_PowerBIReportServer = Installing Power BI Report Server. (SRSS0013)
+    Repairing_ReportingServices = Repairing SQL Server Reporting Services. (SRSS0014)
+    Repairing_PowerBIReportServer = Repairing Power BI Report Server. (SRSS0015)
+    Uninstalling_ReportingServices = Uninstalling SQL Server Reporting Services. (SRSS0016)
+    Uninstalling_PowerBIReportServer = Uninstalling Power BI Report Server. (SRSS0017)
+    NotDesiredProductVersion = The product version '{0}' is not the desired for the instance '{1}'. Desired version in executable: '{2}'. (SRSS0018)
+    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. (SRSS0019)
+    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. (SRSS0020)
+    CannotDetermineEdition = Could not determine the edition 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 edition. (SRSS0021)
+    NotDesiredEdition = The edition '{0}' is not the desired for the instance '{1}'. Desired edition in executable: '{2}'. (SRSS0022)
 '@
diff --git a/tests/Integration/Resources/DSC_SqlRSSetup.config.ps1 b/tests/Integration/Resources/DSC_SqlRSSetup.config.ps1
@@ -19,7 +19,7 @@ else
                 NodeName             = 'localhost'
                 InstanceName         = if (Test-ContinuousIntegrationTaskCategory -Category 'Integration_PowerBI')
                 {
-                    'PBIRS' # cSpell:ignore PBIRS
+                    'PBIRS'
                 }
                 else
                 {
diff --git a/tests/Unit/Classes/SqlRSSetup.Tests.ps1 b/tests/Unit/Classes/SqlRSSetup.Tests.ps1
@@ -720,7 +720,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {
             }
         }
 
-        Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS
+        Context 'When current state is missing PBIRS instance' {
             Context 'When the install command is successful' {
                 BeforeAll {
                     InModuleScope -ScriptBlock {
@@ -866,7 +866,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {
             }
         }
 
-        Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS
+        Context 'When current state is missing PBIRS instance' {
             Context 'When the uninstall command is successful' {
                 BeforeAll {
                     InModuleScope -ScriptBlock {
@@ -1012,7 +1012,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {
             }
         }
 
-        Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS
+        Context 'When current state is missing PBIRS instance' {
             Context 'When the repair command is successful' {
                 BeforeAll {
                     InModuleScope -ScriptBlock {

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,6 @@`
`162`	`162`	`[DscResource(RunAsCredential = 'Optional')]`
`163`	`163`	`class SqlRSSetup : ResourceBase`
`164`	`164`	`{`
`165`		`- # cSpell:ignore SSRS PBIRS`
`166`	`165`	`[DscProperty(Key)]`
`167`	`166`	`[System.String]`
`168`	`167`	`$InstanceName`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ else`
`19`	`19`	`NodeName = 'localhost'`
`20`	`20`	`InstanceName = if (Test-ContinuousIntegrationTaskCategory -Category 'Integration_PowerBI')`
`21`	`21`	`{`
`22`		`- 'PBIRS' # cSpell:ignore PBIRS`
	`22`	`+ 'PBIRS'`
`23`	`23`	`}`
`24`	`24`	`else`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -720,7 +720,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {`
`720`	`720`	`}`
`721`	`721`	`}`
`722`	`722`
`723`		`- Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS`
	`723`	`+ Context 'When current state is missing PBIRS instance' {`
`724`	`724`	`Context 'When the install command is successful' {`
`725`	`725`	`BeforeAll {`
`726`	`726`	`InModuleScope -ScriptBlock {`
`@@ -866,7 +866,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {`
`866`	`866`	`}`
`867`	`867`	`}`
`868`	`868`
`869`		`- Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS`
	`869`	`+ Context 'When current state is missing PBIRS instance' {`
`870`	`870`	`Context 'When the uninstall command is successful' {`
`871`	`871`	`BeforeAll {`
`872`	`872`	`InModuleScope -ScriptBlock {`
`@@ -1012,7 +1012,7 @@ Describe 'SqlRSSetup\Modify()' -Tag 'Modify' {`
`1012`	`1012`	`}`
`1013`	`1013`	`}`
`1014`	`1014`
`1015`		`- Context 'When current state is missing PBIRS instance' { # cSpell:ignore PBIRS`
	`1015`	`+ Context 'When current state is missing PBIRS instance' {`
`1016`	`1016`	`Context 'When the repair command is successful' {`
`1017`	`1017`	`BeforeAll {`
`1018`	`1018`	`InModuleScope -ScriptBlock {`