LLI Wiki — My Digital Knowledge Base

Tester du PowerShell orienté SQL avec Pester, sans base de données

Mocker la couche d'accès aux données, tester les modèles SQL et les fichiers de config, et exécuter les tests en CI sans base.

Le PowerShell qui parle à SQL Server est le code que l'on craint le plus de tester : il faut un serveur, des identifiants, des données dans un état connu, et un test en échec peut être un réseau en panne. Mon approche : arrêter de tester la base et tester tout ce qu'il y a autour. En pratique, cela couvre environ 90 % des bugs que je livre.

Où sont vraiment les bugs

Regardez les défauts d'un module d'outillage DBA : une mauvaise valeur de retour sur le chemin d'échec, un placeholder jamais remplacé, une clé de config absente dans un environnement, un appel destructif fait alors qu'il devait être sauté, une boucle de retry qui ne s'arrête jamais. Aucun n'exige une vraie base. Ils exigent d'exécuter le code avec une couche d'accès aux données factice.

Pester 5 uniquement

Windows PowerShell embarque Pester 3.4, dont la syntaxe et la portée diffèrent. Installez Pester 5 explicitement et importez-le avec une version minimale avant de lancer :

Install-Module Pester -MinimumVersion 5.5 -Scope CurrentUser -SkipPublisherCheck
Import-Module Pester -MinimumVersion 5.5
Invoke-Pester -Path .\Tests\ -Output Detailed

Les tests vivent dans un dossier Tests/ à la racine du module ou de l'application, jamais dans des dossiers dot-sourcés au démarrage.

Mocker la couche d'accès aux données

Le choix de conception clé : une seule fonction fine est le seul endroit où le SQL est réellement exécuté. Toutes les autres l'appellent. En test, cette fonction est mockée et le test vérifie ce qu'on lui a demandé.

BeforeAll {
    Import-Module "$PSScriptRoot\..\Contoso.Dba.psd1" -Force
}

Describe 'Get-PoolUsage' {
    Context 'success' {
        BeforeAll {
            Mock Invoke-SqlQuery -ModuleName Contoso.Dba {
                [pscustomobject]@{ PoolName = 'pool-elp-01'; CpuPercent = 42 }
            }
        }
        It 'returns the rows with IsValid true' {
            $r = Get-PoolUsage -ServerName 'sql-contoso-prd' -LogFile (Join-Path $TestDrive 't.log')
            $r.IsValid | Should -BeTrue
            $r.Data[0].CpuPercent | Should -Be 42
        }
    }
    Context 'failure' {
        BeforeAll { Mock Invoke-SqlQuery -ModuleName Contoso.Dba { throw 'login timeout' } }
        It 'returns IsValid false with a reason' {
            $r = Get-PoolUsage -ServerName 'sql-contoso-prd' -LogFile (Join-Path $TestDrive 't.log')
            $r.IsValid | Should -BeFalse
            $r.Reason  | Should -Match 'login timeout'
        }
    }
}

Trois habitudes comptent :

Pour les opérations destructives, l'assertion est inverse. Pour une fonction qui ne doit rien supprimer en mode simulation :

Should -Invoke Remove-Database -Times 0 -ModuleName Contoso.Dba

Tester les modèles SQL

Si le SQL vit dans des fichiers modèles avec placeholders, testez l'expansion du modèle plutôt que le résultat de la requête :

It 'replaces every placeholder' {
    $sql = Expand-SqlTemplate -Name 'PoolUsage' -Values @{ DatabaseName = 'AppDb' }
    $sql | Should -Match 'AppDb'
    $sql | Should -Not -Match '\{\{'
}
It 'fails on a missing value' {
    { Expand-SqlTemplate -Name 'PoolUsage' -Values @{} } | Should -Throw
}

Bonus peu coûteux : chaque fichier .sql n'a plus de placeholder après expansion avec le jeu complet de valeurs, et chaque placeholder utilisé est documenté. Pour valider la syntaxe sans serveur, une bibliothèque d'analyse T-SQL peut parser le texte développé et remonter les erreurs ; c'est optionnel et utile surtout pour les scripts critiques.

Tester les fichiers de config

Les fichiers de config sont du code déguisé : une clé manquante dans un environnement échoue à 3 h du matin. Testez-les à la découverte :

BeforeDiscovery {
    $files = Get-ChildItem "$PSScriptRoot\..\config\config-*.json" |
             Where-Object Name -ne 'config-common.json'
}
Describe 'config <_.Name>' -ForEach $files {
    It 'is valid JSON' { { Get-Content $_.FullName -Raw | ConvertFrom-Json } | Should -Not -Throw }
    It 'has the required keys' {
        $c = Get-Content $_.FullName -Raw | ConvertFrom-Json
        $c.sqlServer | Should -Not -BeNullOrEmpty
    }
}

BeforeDiscovery est important en Pester 5 : les données qui génèrent les tests doivent exister à la découverte, pas dans BeforeAll.

Exécuter en CI sans base

Comme rien de réel n'est touché, les mêmes tests tournent sur un agent hébergé sans accès réseau à SQL ni connexion Azure :

steps:
  - pwsh: |
      Install-Module Pester -MinimumVersion 5.5 -Scope CurrentUser -Force -SkipPublisherCheck
      $cfg = New-PesterConfiguration
      $cfg.Run.Path = './Tests'
      $cfg.Run.Exit = $true
      $cfg.TestResult.Enabled = $true
      Invoke-Pester -Configuration $cfg
    displayName: Pester

Publiez le fichier de résultats pour que les échecs apparaissent dans l'interface du pipeline. Un test qui exige un vrai serveur est un test d'intégration : rangez-le dans un dossier séparé, étiquetez-le et lancez-le à la demande.

Retour d'expérience

Mastodon LLIMastodon SocialFosstodon