Add integration test stage for DSCv3

.vscode/settings.json

@@ -77,7 +77,8 @@
         "analyzersettings",
         "sqlcmd",
         "PBIRS",
-        "SSRS"
+        "SSRS",
+        "PSDSC"
     ],
     "cSpell.ignorePaths": [
         ".git"

CHANGELOG.md

@@ -78,6 +78,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added new instructions for GitHub Copilot that might assist when developing
   command and private functions in the module. More instructions should be
   added as needed to help generated code and tests.
+- Add integration test in DSCv3.
 
 ### Changed
 

azure-pipelines.yml

@@ -710,6 +710,99 @@ stages:
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
               testRunTitle: 'Integration RS ($(TEST_CONFIGURATION) / $(JOB_VMIMAGE))'
 
+  - stage: Integration_Test_DSCv3_Resources_PowerBIReportServer
+    displayName: 'Integration Test DSCv3 Resources - Power BI Report Server'
+    #dependsOn: Quality_Test_and_Unit_Test
+    dependsOn: Build
+    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'
+        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'
+          - pwsh: |
+              Install-PSResource -Name 'PSDSC' -Repository 'PSGallery' -TrustRepository -Quiet -Confirm:$false
+              #Install-DscExe -Force -Verbose
+              Install-DscExe -IncludePrerelease -Force -Verbose
+            name: installDSCv3
+            displayName: 'Install DSCv3'
+          - pwsh: |
+              # Install-DscExe installs in the path $env:LOCALAPPDATA\dsc
+              $env:PATH += '{0}{1}' -f [System.IO.Path]::PathSeparator, (Join-Path -Path $env:LOCALAPPDATA -ChildPath 'dsc')
+              # Make the built module available to the current session.
+              ./build.ps1 -Tasks noop
+              Get-Module -Name SqlServerDsc -ListAvailable
+              # Output DSCv3 version
+              dsc --version
+              # Get the list of available resources.
+              'Native resources:'
+              dsc resource list
+              'Resources using adapter Microsoft.Windows/WindowsPowerShell:'
+              dsc resource list --adapter Microsoft.Windows/WindowsPowerShell
+
+              Get-ChildItem -Path (Join-Path -Path $env:LOCALAPPDATA -ChildPath 'dsc') -Recurse -Filter '*.json'
+              $cacheFile = Join-Path -Path $env:LOCALAPPDATA -ChildPath 'dsc/WindowsPSAdapterCache.json'
+              $getConfig = Get-Content -Path $cacheFile -Raw | ConvertFrom-Json
+              Write-Verbose -Message "WindowsPSAdapterCache.json content:`n $($getConfig | ConvertTo-Json -Depth 10)" -Verbose
+            name: getDSCv3AvailableResources
+            displayName: 'Get DSCv3 Available Resources'
+          - pwsh: |
+              # Install-DscExe installed in the path $env:LOCALAPPDATA\dsc
+              $env:PATH += '{0}{1}' -f [System.IO.Path]::PathSeparator, (Join-Path -Path $env:LOCALAPPDATA -ChildPath 'dsc')
+              ./build.ps1 -Tasks test -CodeCoverageThreshold 0 -PesterTag $(TEST_CONFIGURATION) -PesterPath @(
+                  # Run the integration tests in a specific group order.
+                  # Prerequisites
+                  # TODO: Move the prerequisites tests to generic folder than Commands
+                  'tests/Integration/Resources/DSCv3_DebugDscEngine.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Prerequisites.Integration.Tests.ps1'
+                  # Group 1
+                  #'tests/Integration/Resources/DSC_SqlSetup.Integration.Tests.ps1'
+                  # Group 2
+                  'tests/Integration/Resources/DSCv3_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_ReportingServices_dbatools
     displayName: 'Integration Test Resources - Reporting Services (dbatools)'
     dependsOn: Integration_Test_Resources_SqlServer

source/Classes/020.DebugDscEngine.ps1

@@ -0,0 +1,256 @@
+<#
+    .SYNOPSIS
+        The `DebugDscEngine` DSC resource is used for debugging and testing
+        purposes to demonstrate DSC resource patterns and behaviors.
+
+    .DESCRIPTION
+        The `DebugDscEngine` DSC resource is used for debugging and testing
+        purposes to demonstrate DSC resource patterns and behaviors. This
+        resource does not perform any actual configuration changes but instead
+        outputs verbose messages to help understand the DSC resource lifecycle
+        and method execution flow.
+
+        The built-in parameter **PSDscRunAsCredential** can be used to run the resource
+        as another user.
+
+        ## Requirements
+
+        * No specific requirements - this is a debug resource for testing purposes.
+
+        ## Known issues
+
+        All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+DebugDscEngine).
+
+    .PARAMETER KeyProperty
+        Specifies the key property for the resource. This is a required property
+        that uniquely identifies the resource instance.
+
+    .PARAMETER MandatoryProperty
+        Specifies a mandatory property that must be provided when using the resource.
+        This demonstrates how mandatory properties work in DSC resources.
+
+    .PARAMETER WriteProperty
+        Specifies an optional write property that can be configured by the resource.
+        This property can be enforced and will be compared during Test() operations.
+
+    .PARAMETER ReadProperty
+        Specifies a read-only property that is returned by the resource but cannot
+        be configured. This property is populated during Get() operations to show
+        the current state.
+
+    .NOTES
+        This resource is designed for debugging and testing purposes only.
+        It demonstrates the proper patterns for creating DSC class-based resources
+        following the SqlServerDsc module conventions.
+
+    .EXAMPLE
+        Configuration Example
+        {
+            Import-DscResource -ModuleName SqlServerDsc
+
+            Node localhost
+            {
+                DebugDscEngine 'TestResource'
+                {
+                    KeyProperty       = 'UniqueIdentifier'
+                    MandatoryProperty = 'RequiredValue'
+                    WriteProperty     = 'ConfigurableValue'
+                }
+            }
+        }
+
+        This example shows how to use the DebugDscEngine resource for testing.
+#>
+[DscResource(RunAsCredential = 'Optional')]
+class DebugDscEngine : ResourceBase
+{
+    [DscProperty(Key)]
+    [System.String]
+    $KeyProperty
+
+    [DscProperty(Mandatory)]
+    [System.String]
+    $MandatoryProperty
+
+    [DscProperty()]
+    [System.String]
+    $WriteProperty
+
+    [DscProperty(NotConfigurable)]
+    [System.String]
+    $ReadProperty
+
+    DebugDscEngine () : base ($PSScriptRoot)
+    {
+        # These properties will not be enforced.
+        $this.ExcludeDscProperties = @(
+            'MandatoryProperty'
+        )
+    }
+
+    [DebugDscEngine] Get()
+    {
+        # Output all environment variables to verify the environment
+        #Write-Verbose -Message "`nEnvironment Variables from inside DSC resource:`n$([System.Environment]::GetEnvironmentVariables().GetEnumerator() | Sort-Object Key | ForEach-Object { "$($_.Key) = $($_.Value)" } | Out-String)" -Verbose
+        #Write-Warning -Message 'Mocked warning message for testing purposes.'
+
+        # Call the base method to return the properties.
+        return ([ResourceBase] $this).Get()
+    }
+
+    [System.Boolean] Test()
+    {
+        # Call the base method to test all of the properties that should be enforced.
+        return ([ResourceBase] $this).Test()
+    }
+
+    [void] Set()
+    {
+        # Call the base method to enforce the properties.
+        ([ResourceBase] $this).Set()
+    }
+
+    <#
+        Base method Get() call this method to get the current state as a hashtable.
+        The parameter properties will contain the key properties.
+    #>
+    hidden [System.Collections.Hashtable] GetCurrentState([System.Collections.Hashtable] $properties)
+    {
+        Write-Verbose -Message (
+            $this.localizedData.Getting_CurrentState -f @(
+                $properties.KeyProperty
+            )
+        )
+
+        Write-Verbose -Message (
+            $this.localizedData.Debug_GetCurrentState_Called -f @(
+                $properties.KeyProperty,
+                ($properties.Keys -join ', ')
+            )
+        )
+
+        $currentState = @{
+            KeyProperty       = $properties.KeyProperty
+            MandatoryProperty = 'CurrentMandatoryStateValue'
+            WriteProperty     = 'CurrentStateValue'
+            ReadProperty      = 'ReadOnlyValue_' + (Get-Date -Format 'yyyyMMdd_HHmmss')
+        }
+
+        Write-Verbose -Message (
+            $this.localizedData.Debug_GetCurrentState_Returning -f @(
+                ($currentState.Keys -join ', ')
+            )
+        )
+
+        return $currentState
+    }
+
+    <#
+        Base method Set() call this method with the properties that are not in
+        desired state and should be enforced. It is not called if all properties
+        are in desired state. The variable $properties contains only the properties
+        that are not in desired state.
+    #>
+    hidden [void] Modify([System.Collections.Hashtable] $properties)
+    {
+        Write-Verbose -Message (
+            $this.localizedData.Debug_Modify_Called -f @(
+                $this.KeyProperty,
+                ($properties.Keys -join ', ')
+            )
+        )
+
+        foreach ($propertyName in $properties.Keys)
+        {
+            $propertyValue = $properties[$propertyName]
+
+            Write-Verbose -Message (
+                $this.localizedData.Debug_Modify_Property -f @(
+                    $propertyName,
+                    $propertyValue
+                )
+            )
+
+            # Simulate setting the property
+            Start-Sleep -Milliseconds 100
+        }
+
+        Write-Verbose -Message (
+            $this.localizedData.Debug_Modify_Completed -f $this.KeyProperty
+        )
+    }
+
+    <#
+        Base method Assert() call this method with the properties that was assigned
+        a value.
+    #>
+    hidden [void] AssertProperties([System.Collections.Hashtable] $properties)
+    {
+        Write-Verbose -Message (
+            $this.localizedData.Debug_AssertProperties_Called -f @(
+                $this.KeyProperty,
+                ($properties.Keys -join ', ')
+            )
+        )
+
+        # Validate that KeyProperty is not null or empty
+        if ([System.String]::IsNullOrEmpty($properties.KeyProperty))
+        {
+            New-ArgumentException -ArgumentName 'KeyProperty' -Message $this.localizedData.KeyProperty_Invalid
+        }
+
+        # Validate that MandatoryProperty is not null or empty
+        if ([System.String]::IsNullOrEmpty($properties.MandatoryProperty))
+        {
+            New-ArgumentException -ArgumentName 'MandatoryProperty' -Message $this.localizedData.MandatoryProperty_Invalid
+        }
+
+        Write-Verbose -Message (
+            $this.localizedData.Debug_AssertProperties_Completed -f $this.KeyProperty
+        )
+    }
+
+    <#
+        Base method Normalize() call this method with the properties that was assigned
+        a value.
+    #>
+    hidden [void] NormalizeProperties([System.Collections.Hashtable] $properties)
+    {
+        Write-Verbose -Message (
+            $this.localizedData.Debug_NormalizeProperties_Called -f @(
+                $this.KeyProperty,
+                ($properties.Keys -join ', ')
+            )
+        )
+
+        # Normalize KeyProperty to uppercase
+        if ($properties.ContainsKey('KeyProperty'))
+        {
+            $this.KeyProperty = $properties.KeyProperty.ToUpper()
+
+            Write-Verbose -Message (
+                $this.localizedData.Debug_NormalizeProperties_Property -f @(
+                    'KeyProperty',
+                    $this.KeyProperty
+                )
+            )
+        }
+
+        # Normalize WriteProperty to trim whitespace
+        if ($properties.ContainsKey('WriteProperty'))
+        {
+            $this.WriteProperty = $properties.WriteProperty.Trim()
+
+            Write-Verbose -Message (
+                $this.localizedData.Debug_NormalizeProperties_Property -f @(
+                    'WriteProperty',
+                    $this.WriteProperty
+                )
+            )
+        }
+
+        Write-Verbose -Message (
+            $this.localizedData.Debug_NormalizeProperties_Completed -f $this.KeyProperty
+        )
+    }
+}

source/en-US/DebugDscEngine.strings.psd1

@@ -0,0 +1,15 @@
+@{
+    Getting_CurrentState                    = "Getting current state for DebugDscEngine resource with KeyProperty '{0}'."
+    Debug_GetCurrentState_Called           = "GetCurrentState method called for KeyProperty '{0}' with properties: {1}."
+    Debug_GetCurrentState_Returning        = "GetCurrentState method returning properties: {0}."
+    Debug_Modify_Called                    = "Modify method called for KeyProperty '{0}' with properties to modify: {1}."
+    Debug_Modify_Property                  = "Modifying property '{0}' to value '{1}'."
+    Debug_Modify_Completed                 = "Modify method completed for KeyProperty '{0}'."
+    Debug_AssertProperties_Called          = "AssertProperties method called for KeyProperty '{0}' with properties: {1}."
+    Debug_AssertProperties_Completed       = "AssertProperties method completed for KeyProperty '{0}'."
+    Debug_NormalizeProperties_Called       = "NormalizeProperties method called for KeyProperty '{0}' with properties: {1}."
+    Debug_NormalizeProperties_Property     = "Normalized property '{0}' to value '{1}'."
+    Debug_NormalizeProperties_Completed    = "NormalizeProperties method completed for KeyProperty '{0}'."
+    KeyProperty_Invalid                    = "The parameter KeyProperty cannot be null or empty."
+    MandatoryProperty_Invalid              = "The parameter MandatoryProperty cannot be null or empty."
+}

source/suffix.ps1

@@ -21,6 +21,6 @@ if (-not $env:SqlServerDscCI)
             It is not possible to throw the error from Import-SqlDscPreferredModule
             since it will just fail the command Import-Module with an obscure error.
         #>
-        Write-Warning -Message $_.Exception.Message
+        #Write-Warning -Message $_.Exception.Message
     }
 }