Merge branch 'main' into SqlPermissionWithRole

Author: johlju

.github/copilot-instructions.md

@@ -34,14 +34,6 @@ jobs:
         run: |
           Write-Information -MessageData 'Resolving dependencies.' -InformationAction 'Continue'
           .\build.ps1 -ResolveDependency -Tasks 'noop'
-      # This is a workaround for the issue: https://github.com/PoshCode/ModuleBuilder/pull/136
-      - name: Patch ModuleBuilder
-        shell: powershell
-        run: |
-          Write-Information -MessageData 'Patching ModuleBuilder v3.1.7.' -InformationAction 'Continue'
-          .\build.ps1 -Tasks 'noop'
-          Install-PSResource -Name 'Viscalyx.Common' -Repository 'PSGallery' -TrustRepository -Quiet -Confirm:$false
-          Install-ModulePatch -Uri https://raw.githubusercontent.com/viscalyx/Viscalyx.Common/refs/heads/main/patches/ModuleBuilder_3.1.7_patch.json -Force
       - name: Build Module
         shell: powershell
         run: |

.github/workflows/code-analysis-built-module.yml

@@ -34,14 +34,6 @@ jobs:
         run: |
           Write-Information -MessageData 'Resolving dependencies.' -InformationAction 'Continue'
           .\build.ps1 -ResolveDependency -Tasks 'noop'
-      # This is a workaround for the issue: https://github.com/PoshCode/ModuleBuilder/pull/136
-      - name: Patch ModuleBuilder
-        shell: powershell
-        run: |
-          Write-Information -MessageData 'Patching ModuleBuilder v3.1.7.' -InformationAction 'Continue'
-          .\build.ps1 -Tasks 'noop'
-          Install-PSResource -Name 'Viscalyx.Common' -Repository 'PSGallery' -TrustRepository -Quiet -Confirm:$false
-          Install-ModulePatch -Uri https://raw.githubusercontent.com/viscalyx/Viscalyx.Common/refs/heads/main/patches/ModuleBuilder_3.1.7_patch.json -Force
       - name: Build Module
         shell: powershell
         run: |

.github/workflows/code-analysis.yml

@@ -73,7 +73,7 @@
 
     <#
         The following types are not rules but parse errors reported by PSScriptAnalyzer
-        so they cannot be ecluded. They need to be filtered out from the result of
+        so they cannot be excluded. They need to be filtered out from the result of
         Invoke-ScriptAnalyzer.
 
         TypeNotFound - Because classes in the project cannot be found unless built.

.vscode/analyzersettings.psd1

@@ -75,7 +75,9 @@
         "fastbuild",
         "CODEOWNERS",
         "analyzersettings",
-        "sqlcmd"
+        "sqlcmd",
+        "PBIRS",
+        "SSRS"
     ],
     "cSpell.ignorePaths": [
         ".git"

.vscode/settings.json

@@ -4,33 +4,67 @@ The format is based on and uses the types of changes according to [Keep a Change
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
 ### Removed
 
+- SqlServerDsc
+  - Revert workaround in GitHub Actions workflows as new version of ModuleBuilder
+    was released.
 - SqlServerDsc.Common
-  - Removed the function `Get-RegistryPropertyValue` and `Format-Path` in
-    favor of the commands with the same names in the module _DscResource.Common_.
+  - Removed the function `Get-RegistryPropertyValue`, `Format-Path` and
+    `Test-PendingRestart` in favor of the commands with the same names in
+    the module _DscResource.Common_.
+- SqlRSSetup
+  - The DSC resource has been refactored into a class-based resource.
+    - The parameter `SourcePath` was replaced with `MediaPath`.
+    - The parameter `IAcceptLicensTerms` was replaced with a boolean parameter
+      `AcceptLicensingTerms`.
+    - The parameter `SourceCredential` was removed. Because of this, the
+      functionality that allowed copying the media from a UNC path using
+      those credentials was also removed. If this was something you used,
+      please open an issue.
+    - The version validation no longer gets the current version from the
+      installed package (using `Get-Package`), but instead from the registry.
+    - Prior when install was successful, the resource checked whether there
+      were any pending rename operations. Since the install returns 3010
+      if a restart is needed it is now assumed that the setup process takes
+      care of this. If that is not the case, and this check is needed, then
+      open an issue to discuss in what cases this is needed.
+    - The `Edition` option 'Development` was replaced by the value
+      `Developer`.
+    - The read-only properties `CurrentVersion`, `ServiceName` and `ErrorDumpDirectory`
+      were removed.
 
 ### Added
 
 - Public commands:
   - `Get-SqlDscInstalledInstance` to retrieve installed SQL instances.
   - `Get-SqlDscRSSetupConfiguration` to retrieve the setup configuration of
     SQL Server Reporting Services or Power BI Report Server ([issue #2072](https://github.com/dsccommunity/SqlServerDsc/issues/2072)).
+    - Add additional properties to `Get-SqlDscRSSetupConfiguration` output.
   - `Install-SqlDscReportingService` to install SQL Server Reporting Services
     ([issue #2010](https://github.com/dsccommunity/SqlServerDsc/issues/2010)).
+    - Add `PassThru` parameter to return exit code.
   - `Install-SqlDscBIReportServer` to install SQL Server BI Report Server.
     ([issue #2010](https://github.com/dsccommunity/SqlServerDsc/issues/2010)).
+    - Add `PassThru` parameter to return exit code.
   - `Repair-SqlDscReportingService` to repair an already installed SQL Server
     Reporting Services ([issue #2064](https://github.com/dsccommunity/SqlServerDsc/issues/2064)).
+    - Add `PassThru` parameter to return exit code.
   - `Repair-SqlDscBIReportServer` to repair an already installed SQL Server
     BI Report Server ([issue #2064](https://github.com/dsccommunity/SqlServerDsc/issues/2064)).
+    - Add `PassThru` parameter to return exit code.
   - `Test-SqlDscRSInstalled` to test whether an instance is installed or not
      ([issue #2078](https://github.com/dsccommunity/SqlServerDsc/issues/2078)).
   - `Uninstall-SqlDscReportingService` to uninstall SQL Server Reporting
     Services ([issue #2065](https://github.com/dsccommunity/SqlServerDsc/issues/2065)).
+    - Add `PassThru` parameter to return exit code.
   - `Uninstall-SqlDscBIReportServer` to uninstall SQL Server BI Report Server
     ([issue #2065](https://github.com/dsccommunity/SqlServerDsc/issues/2065)).
-   - `Test-SqlDscIsRole` to be used like `Test-SqlDscIsLogin` but tests for a
+    - Add `PassThru` parameter to return exit code.
+  - `ConvertTo-SqlDscEditionName` to return the edition name of the specified
+    edition ID.
+  - `Test-SqlDscIsRole` to be used like `Test-SqlDscIsLogin` but tests for a
      server role as principal.
 - Private function:
   - `Invoke-ReportServerSetupAction` to run setup actions for Reporting
@@ -60,18 +94,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Fix style formatting in all PowerShell script files.
   - Update module description on GitHub, in the conceptual help, and in
     the module manifest.
-- `Set-SqlDscServerPermission`
-  - Added support for assigning permissions to a server role.
+  - Now integration tests will fail on an exception when the command `Test-DscConfiguration`
+    is run.
+  - Added Test-SqlDscIsRole to be used like Test-SqlDscIsLogin but tests
+    for a server role as principal.
+  - Refine and enhance clarity in Copilot instructions.
 - SqlSetup
   - Fixed issue with AddNode where cluster IP information was not being passed to
     setup.exe ([issue #1171](https://github.com/dsccommunity/SqlServerDsc/issues/1171)).
+- SqlRSSetup
+  - The DSC resource has been refactored into a class-based resource.
+- `Set-SqlDscServerPermission`
+  - Added support for assigning permissions to a server role.
 
 ### Fixed
 
 - Fixed workaround for the GitHub Actions to support building module in Windows
   PowerShell.
+- Fix tests to redirect output streams correctly.
 - SqlServerDsc
   - Fix localization tests.
+  - Cleanup in unit tests for classes.
+  - Cleanup in localization string files.
 - `SqlAudit`
   - Fix localization strings in `Assert` method.
 - `Save-SqlDscSqlServerMediaFile`
@@ -95,6 +139,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Change the alias command to real command name, to pass HQRM tests.
 - `SqlServiceAccount`
   - Change the alias command to real command name, to pass HQRM tests.
+- `Get-SqlDscRSSetupConfiguration`
+  - The integration test was updated to verify so that the `CurrentVersion`
+    and `ProductVersion` strings can be converted to valid versions and
+    that they always are higher than what we expect.
+- `SqlRS`
+  - Re-enable integration tests.
+- `SqlAG`
+  - Fix SeedingMode existence condition.
+- `SqlAGReplica`
+  - Fix SeedingMode existence condition.
 
 ## [17.0.0] - 2024-09-30
 

CHANGELOG.md

@@ -123,7 +123,7 @@ stages:
       - job: Test_Unit
         displayName: 'Unit'
         pool:
-          vmImage: 'windows-2019'
+          vmImage: 'windows-2022'
         timeoutInMinutes: 0
         variables:
           # This sets environment variable $env:SqlServerDscCI.
@@ -204,9 +204,6 @@ stages:
             SQL2016_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2016'
-            SQL2016_WIN2022:
-              JOB_VMIMAGE: 'windows-2022'
-              TEST_CONFIGURATION: 'Integration_SQL2016'
             SQL2017_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2017'
@@ -219,12 +216,18 @@ stages:
             SQL2019_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2019'
+            SQL2019_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2019'
             SQL2022_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2022'
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2022_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2022'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: 0
@@ -289,12 +292,18 @@ stages:
             SQL2019_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2019_RS'
+            SQL2019_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2019_RS'
             SQL2022_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2022_RS'
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022_RS'
+            SQL2022_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2022_RS'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: 0
@@ -352,12 +361,15 @@ stages:
         displayName: 'Commands'
         strategy:
           matrix:
-            SQL2022_WIN2019:
+            PowerBI_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_PowerBI'
-            SQL2022_WIN2022:
+            PowerBI_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_PowerBI'
+            PowerBI_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_PowerBI'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: 0
@@ -418,9 +430,6 @@ stages:
             SQL2016_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2016'
-            SQL2016_WIN2022:
-              JOB_VMIMAGE: 'windows-2022'
-              TEST_CONFIGURATION: 'Integration_SQL2016'
             SQL2017_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2017'
@@ -433,12 +442,18 @@ stages:
             SQL2019_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2019'
+            SQL2019_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2019'
             SQL2022_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2022'
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2022_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2022'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: 0
@@ -517,8 +532,8 @@ stages:
         displayName: 'Integration'
         strategy:
           matrix:
-            SQL2016_WIN2022:
-              JOB_VMIMAGE: 'windows-2022'
+            SQL2016_WIN2019:
+              JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2016'
             SQL2017_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
@@ -613,9 +628,6 @@ stages:
             SQL2016_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2016'
-            SQL2016_WIN2022:
-              JOB_VMIMAGE: 'windows-2022'
-              TEST_CONFIGURATION: 'Integration_SQL2016'
             SQL2017_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2017'
@@ -628,12 +640,83 @@ stages:
             SQL2019_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2019'
+            SQL2019_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2019'
             SQL2022_WIN2019:
               JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2022'
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2022_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2022'
+        variables:
+          SKIP_DATABASE_ENGINE_DEFAULT_INSTANCE: true
+          SKIP_ANALYSIS_MULTI_INSTANCE: true
+          SKIP_ANALYSIS_TABULAR_INSTANCE: true
+          SMODefaultModuleName: 'SqlServer'
+        pool:
+          vmImage: $(JOB_VMIMAGE)
+        timeoutInMinutes: 0
+        steps:
+          - task: DownloadPipelineArtifact@2
+            displayName: 'Download Build Artifact'
+            inputs:
+              buildType: 'current'
+              artifactName: $(buildArtifactName)
+              targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)'
+          - task: PowerShell@2
+            name: configureWinRM
+            displayName: 'Configure WinRM'
+            inputs:
+              targetType: 'inline'
+              script: 'winrm quickconfig -quiet'
+              pwsh: false
+          - powershell: |
+              Import-Module -Name ./tests/TestHelpers/CommonTestHelper.psm1
+              Remove-PowerShellModuleFromCI -Name @('SqlServer', 'SQLPS')
+              Remove-Module -Name CommonTestHelper
+            name: cleanCIWorker
+            displayName: 'Clean CI worker'
+          - powershell: |
+              ./build.ps1 -Tasks test -CodeCoverageThreshold 0 -PesterTag $(TEST_CONFIGURATION) -PesterPath @(
+                  # Run the integration tests in a specific group order.
+                  # Group 1
+                  'tests/Integration/Resources/DSC_SqlSetup.Integration.Tests.ps1'
+                  # Group 2
+                  'tests/Integration/Resources/DSC_SqlRSSetup.Integration.Tests.ps1'
+                  # Group 3
+                  'tests/Integration/Resources/DSC_SqlRS.Integration.Tests.ps1'
+              )
+            name: test
+            displayName: 'Run Reporting Services Integration Test'
+          - task: PublishTestResults@2
+            displayName: 'Publish Test Results'
+            condition: succeededOrFailed()
+            inputs:
+              testResultsFormat: 'NUnit'
+              testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
+              testRunTitle: 'Integration RS ($(TEST_CONFIGURATION) / $(JOB_VMIMAGE))'
+
+  - stage: Integration_Test_Resources_PowerBIReportServer
+    displayName: 'Integration Test Resources - Power BI Report Server'
+    dependsOn: Quality_Test_and_Unit_Test
+    jobs:
+      - job: Test_Integration
+        displayName: 'Integration'
+        strategy:
+          matrix:
+            PowerBI_WIN2019:
+              JOB_VMIMAGE: 'windows-2019'
+              TEST_CONFIGURATION: 'Integration_PowerBI'
+            PowerBI_WIN2022:
+              JOB_VMIMAGE: 'windows-2022'
+              TEST_CONFIGURATION: 'Integration_PowerBI'
+            PowerBI_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_PowerBI'
         variables:
           SKIP_DATABASE_ENGINE_DEFAULT_INSTANCE: true
           SKIP_ANALYSIS_MULTI_INSTANCE: true
@@ -690,8 +773,8 @@ stages:
         displayName: 'Integration'
         strategy:
           matrix:
-            SQL2016_WIN2022:
-              JOB_VMIMAGE: 'windows-2022'
+            SQL2016_WIN2019:
+              JOB_VMIMAGE: 'windows-2019'
               TEST_CONFIGURATION: 'Integration_SQL2016'
             SQL2017_WIN2022:
               JOB_VMIMAGE: 'windows-2022'