SqlReliabilityKit

0.6.0

Tests/SqlReliabilityKit.Tests.ps1

#requires -Module Pester

# Structural tests for SqlReliabilityKit. These validate the module contract without
# needing a live SQL Server. Run with: Invoke-Pester ./Tests

BeforeAll {
    $script:ModuleRoot = Split-Path $PSScriptRoot -Parent
    $script:ManifestPath = Join-Path $script:ModuleRoot 'SqlReliabilityKit.psd1'
}

Describe 'Module manifest' {
    It 'exists' {
        Test-Path $script:ManifestPath | Should -BeTrue
    }
    It 'is a valid manifest' {
        { Test-ModuleManifest -Path $script:ManifestPath -ErrorAction Stop } | Should -Not -Throw
    }
    It 'declares dbatools as a required module' {
        $data = Import-PowerShellDataFile $script:ManifestPath
        ($data.RequiredModules.ModuleName) | Should -Contain 'dbatools'
    }
    It 'exports Find-SqlQueryStoreRegression explicitly' {
        $data = Import-PowerShellDataFile $script:ManifestPath
        $data.FunctionsToExport | Should -Contain 'Find-SqlQueryStoreRegression'
    }
    It 'exports Test-SqlRestoreChain explicitly' {
        $data = Import-PowerShellDataFile $script:ManifestPath
        $data.FunctionsToExport | Should -Contain 'Test-SqlRestoreChain'
    }
}

Describe 'Test-SqlRestoreChain' {
    BeforeAll {
        . (Join-Path $script:ModuleRoot 'Public/Test-SqlRestoreChain.ps1')
    }
    It 'has SqlInstance as a mandatory parameter' {
        (Get-Command Test-SqlRestoreChain).Parameters['SqlInstance'].Attributes.Mandatory | Should -Contain $true
    }
    It 'has a Physical switch' {
        (Get-Command Test-SqlRestoreChain).Parameters['Physical'].SwitchParameter | Should -BeTrue
    }
    It 'has comment-based help with a synopsis' {
        (Get-Help Test-SqlRestoreChain).Synopsis | Should -Not -BeNullOrEmpty
    }
    It 'provides at least one usage example' {
        @((Get-Help Test-SqlRestoreChain).Examples.Example).Count | Should -BeGreaterThan 0
    }
}

Describe 'Find-SqlQueryStoreRegression' {
    BeforeAll {
        . (Join-Path $script:ModuleRoot 'Public/Find-SqlQueryStoreRegression.ps1')
    }
    It 'has SqlInstance as a mandatory parameter' {
        (Get-Command Find-SqlQueryStoreRegression).Parameters['SqlInstance'].Attributes.Mandatory | Should -Contain $true
    }
    It 'has Database as a mandatory parameter' {
        (Get-Command Find-SqlQueryStoreRegression).Parameters['Database'].Attributes.Mandatory | Should -Contain $true
    }
    It 'defaults SlowdownThreshold to 1.5' {
        (Get-Command Find-SqlQueryStoreRegression).Parameters['SlowdownThreshold'] | Should -Not -BeNullOrEmpty
    }
    It 'has comment-based help with a synopsis' {
        (Get-Help Find-SqlQueryStoreRegression).Synopsis | Should -Not -BeNullOrEmpty
    }
    It 'provides at least one usage example' {
        @((Get-Help Find-SqlQueryStoreRegression).Examples.Example).Count | Should -BeGreaterThan 0
    }
}