LLI Wiki — My Digital Knowledge Base

Templates de pipeline réutilisables et conventions : PSScriptAnalyzer et Pester en CI

Fichiers de template avec paramètres, nommage, étapes partagées entre applications, contrôles avant déploiement et qualité PowerShell en CI.

Quand on a une quinzaine d'applications PowerShell, chaque pipeline qui réinvente ses étapes de build et de test devient vite une source de dérives. Je factorise dans des templates YAML réutilisables et je m'impose quelques conventions. Résultat : un nouveau pipeline fait 30 lignes au lieu de 300.

Organisation des fichiers

pipelines/
  templates/
    steps-lint.yml        # PSScriptAnalyzer
    steps-test.yml        # Pester + publication des résultats
    steps-checkout.yml    # checkout multi-dépôts + nettoyage
    steps-deploy-batch.yml
  apps/
    export/build.yml
    export/schedule.yml
  variables/
    dev.yml  acc.yml  prd.yml

Un template ne contient que des steps (ou des jobs). Il ne décide ni du déclencheur ni de l'environnement : c'est le pipeline appelant qui assemble.

Un template avec paramètres

# templates/steps-test.yml
parameters:
  - name: testPath
    type: string
    default: 'Tests'
  - name: minCoverage
    type: number
    default: 0

steps:
  - pwsh: |
      Install-Module Pester -MinimumVersion 5.0 -Force -SkipPublisherCheck -Scope CurrentUser
      $cfg = New-PesterConfiguration
      $cfg.Run.Path = '${{ parameters.testPath }}'
      $cfg.Run.PassThru = $true
      $cfg.TestResult.Enabled = $true
      $cfg.TestResult.OutputPath = 'TestResults.xml'
      $r = Invoke-Pester -Configuration $cfg
      if ($r.FailedCount -gt 0) { throw "$($r.FailedCount) test(s) failed" }
    displayName: 'Pester'

  - task: PublishTestResults@2
    condition: always()
    inputs:
      testResultsFormat: NUnit
      testResultsFiles: '**/TestResults.xml'

Et l'appel :

steps:
  - template: ../../templates/steps-lint.yml
  - template: ../../templates/steps-test.yml
    parameters:
      testPath: 'apps/export/Tests'

Deux détails : condition: always() sur la publication, sinon on perd les résultats justement quand les tests échouent ; et le throw explicite, parce qu'un échec Pester ne fait pas échouer l'étape tout seul.

PSScriptAnalyzer

- pwsh: |
    Install-Module PSScriptAnalyzer -Force -Scope CurrentUser
    $issues = Invoke-ScriptAnalyzer -Path . -Recurse -Severity Error, Warning
    $issues | Format-Table RuleName, Severity, ScriptName, Line -AutoSize
    if ($issues) { throw "$($issues.Count) analyzer finding(s)" }
  displayName: 'PSScriptAnalyzer'

Je bloque sur Error et Warning, pas sur Information : sinon l'équipe finit par désactiver le contrôle.

Conventions de nommage

Élément Convention
Fichiers de template steps-<action>.yml, un rôle par fichier
Pipelines <action>.yml à côté de l'application (build, deploy, schedule)
Variable groups vg-<équipe>-<environnement>
Service connections une par environnement et par périmètre, nom explicite
Artefacts <app>-package, version dans le nom du fichier

Contrôles avant déploiement

Avant de pousser vers Batch, une étape vérifie : le ZIP existe, le fichier de version est présent, le module partagé se charge (Import-Module), la commande de déploiement est disponible. Chaque contrôle échoue tôt et avec un message clair plutôt que trois minutes plus tard dans l'API Azure.

Pièges et retour d'expérience

Mastodon LLIMastodon SocialFosstodon