Disable-SqlDscAudit.Integration.Tests.ps1

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks build" first.'
    }
}

BeforeAll {
    $script:moduleName = 'SqlServerDsc'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Describe 'Disable-SqlDscAudit' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
    BeforeAll {
        # Starting the named instance SQL Server service prior to running tests.
        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'

        $script:mockInstanceName = 'DSCSQLTEST'
        $script:mockComputerName = Get-ComputerName

        $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
        $mockSqlAdministratorPassword = ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force

        $script:mockSqlAdminCredential = [System.Management.Automation.PSCredential]::new($mockSqlAdministratorUserName, $mockSqlAdministratorPassword)

        $script:serverObject = Connect-SqlDscDatabaseEngine -InstanceName $script:mockInstanceName -Credential $script:mockSqlAdminCredential -ErrorAction Stop
    }

    AfterAll {
        Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject

        # Stop the named instance SQL Server service to save memory on the build worker.
        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
    }

    Context 'When disabling an audit using ServerObject parameter set' {
        BeforeEach {
            # Create and enable a test audit for each test
            $script:testAuditName = 'SqlDscTestDisableAudit_' + (Get-Random)
            $null = New-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -LogType 'ApplicationLog' -Force -ErrorAction Stop
            $null = Enable-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -Force -ErrorAction Stop
        }

        AfterEach {
            # Clean up: Remove the test audit if it still exists
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -ErrorAction 'SilentlyContinue'
            if ($existingAudit)
            {
                $null = Remove-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -Force -ErrorAction 'SilentlyContinue'
            }
        }

        It 'Should disable an enabled audit successfully' {
            # Verify audit exists and is enabled before disabling
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -ErrorAction Stop
            $existingAudit | Should -Not -BeNullOrEmpty
            $existingAudit.Enabled | Should -BeTrue

            # Disable the audit
            $null = Disable-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -Force -ErrorAction Stop

            # Verify audit is now disabled
            $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -ErrorAction Stop
            $disabledAudit | Should -Not -BeNullOrEmpty
            $disabledAudit.Enabled | Should -BeFalse
        }

        It 'Should throw error when trying to disable non-existent audit' {
            { Disable-SqlDscAudit -ServerObject $script:serverObject -Name 'NonExistentAudit' -Force -ErrorAction Stop } |
                Should -Throw
        }

        It 'Should support the Refresh parameter' {
            # Verify audit exists and is enabled before disabling
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -ErrorAction Stop
            $existingAudit | Should -Not -BeNullOrEmpty
            $existingAudit.Enabled | Should -BeTrue

            # Disable the audit with Refresh parameter
            $null = Disable-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -Refresh -Force -ErrorAction Stop

            # Verify audit is now disabled
            $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditName -ErrorAction Stop
            $disabledAudit | Should -Not -BeNullOrEmpty
            $disabledAudit.Enabled | Should -BeFalse
        }
    }

    Context 'When disabling an audit using AuditObject parameter set' {
        BeforeEach {
            # Create and enable a test audit for each test
            $script:testAuditNameForObject = 'SqlDscTestDisableAuditObj_' + (Get-Random)
            $null = New-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -LogType 'ApplicationLog' -Force -ErrorAction Stop
            $null = Enable-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -Force -ErrorAction Stop
        }

        AfterEach {
            # Clean up: Remove the test audit if it still exists
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -ErrorAction 'SilentlyContinue'
            if ($existingAudit)
            {
                $null = Remove-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -Force -ErrorAction 'SilentlyContinue'
            }
        }

        It 'Should disable an audit using audit object' {
            $auditObject = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -ErrorAction Stop
            $auditObject | Should -Not -BeNullOrEmpty
            $auditObject.Enabled | Should -BeTrue

            # Disable the audit using audit object
            $null = Disable-SqlDscAudit -AuditObject $auditObject -Force -ErrorAction Stop

            # Verify audit is now disabled
            $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -ErrorAction Stop
            $disabledAudit | Should -Not -BeNullOrEmpty
            $disabledAudit.Enabled | Should -BeFalse
        }

        It 'Should support pipeline input with audit object' {
            $auditObject = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -ErrorAction Stop
            $auditObject | Should -Not -BeNullOrEmpty
            $auditObject.Enabled | Should -BeTrue

            # Disable the audit using pipeline
            $auditObject | Disable-SqlDscAudit -Force -ErrorAction Stop

            # Verify audit is now disabled
            $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForObject -ErrorAction Stop
            $disabledAudit | Should -Not -BeNullOrEmpty
            $disabledAudit.Enabled | Should -BeFalse
        }
    }

    Context 'When disabling an audit using ServerObject parameter set with pipeline' {
        BeforeEach {
            # Create and enable a test audit for each test
            $script:testAuditNameForPipeline = 'SqlDscTestDisableAuditPipe_' + (Get-Random)
            $null = New-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -LogType 'ApplicationLog' -Force -ErrorAction Stop
            $null = Enable-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -Force -ErrorAction Stop
        }

        AfterEach {
            # Clean up: Remove the test audit if it still exists
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -ErrorAction 'SilentlyContinue'
            if ($existingAudit)
            {
                $null = Remove-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -Force -ErrorAction 'SilentlyContinue'
            }
        }

        It 'Should support pipeline input with server object' {
            # Verify audit exists and is enabled before disabling
            $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -ErrorAction Stop
            $existingAudit | Should -Not -BeNullOrEmpty
            $existingAudit.Enabled | Should -BeTrue

            # Disable the audit using pipeline with server object
            $script:serverObject | Disable-SqlDscAudit -Name $script:testAuditNameForPipeline -Force -ErrorAction Stop

            # Verify audit is now disabled
            $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $script:testAuditNameForPipeline -ErrorAction Stop
            $disabledAudit | Should -Not -BeNullOrEmpty
            $disabledAudit.Enabled | Should -BeFalse
        }
    }

    Context 'When disabling multiple audits' {
        BeforeAll {
            # Create and enable multiple test audits
            $script:testAuditNames = @(
                'SqlDscTestMultiDisable1_' + (Get-Random),
                'SqlDscTestMultiDisable2_' + (Get-Random)
            )
            
            foreach ($auditName in $script:testAuditNames)
            {
                $null = New-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -LogType 'ApplicationLog' -Force -ErrorAction Stop
                $null = Enable-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -Force -ErrorAction Stop
            }
        }

        AfterAll {
            # Clean up: Remove all test audits
            foreach ($auditName in $script:testAuditNames)
            {
                $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -ErrorAction 'SilentlyContinue'
                if ($existingAudit)
                {
                    $null = Remove-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -Force -ErrorAction 'SilentlyContinue'
                }
            }
        }

        It 'Should disable multiple audits successfully' {
            # Verify audits exist and are enabled before disabling
            foreach ($auditName in $script:testAuditNames)
            {
                $existingAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -ErrorAction Stop
                $existingAudit | Should -Not -BeNullOrEmpty
                $existingAudit.Enabled | Should -BeTrue
            }

            # Disable the audits
            foreach ($auditName in $script:testAuditNames)
            {
                $null = Disable-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -Force -ErrorAction Stop
            }

            # Verify audits are now disabled
            foreach ($auditName in $script:testAuditNames)
            {
                $disabledAudit = Get-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -ErrorAction Stop
                $disabledAudit | Should -Not -BeNullOrEmpty
                $disabledAudit.Enabled | Should -BeFalse
            }
        }
    }
}