CI

Un espace de travail est un dossier de fichiers texte : il peut donc vivre dans le même dépôt que l’API qu’il teste. En CI, l’outil en ligne de commande vérifie l’espace de travail, exécute ses requêtes avec leurs vérifications et écrit un rapport que votre système de CI affiche. Une vérification en échec fait échouer la tâche.

Ce que fait une tâcheCopy Anchor Link

echolot validate Alpenglow.echolot --env staging
echolot run Alpenglow.echolot --env staging \
  --reporter console --reporter junit --out echolot-results.xml

1. echolot validate repère un fichier cassé ou une variable manquante avant que quoi que ce soit soit envoyé.
2. echolot run envoie les requêtes et exécute leurs vérifications et leurs scripts. console affiche l’exécution dans le journal de la tâche ; junit écrit un fichier que votre CI lit comme des résultats de tests.
3. Le code de sortie est 1 quand une requête échoue : la tâche échoue donc.

Ajoutez --folder pour exécuter une partie de l’espace de travail, --data pour une exécution pilotée par les données, --bail pour s’arrêter au premier échec, et --retries pour une dépendance instable.

Secrets en CICopy Anchor Link

Les fichiers d’un espace de travail ne contiennent aucune valeur secrète : c’est à la CI de les fournir. Stockez chacune dans les secrets de votre CI et transmettez-la comme variable d’environnement nommée ECHOLOT_SECRET_<NAME>, le nom de la variable en majuscules (voir secrets) :

Ou écrivez-les dans un fichier et passez-le avec --secrets ; un NAME=value par ligne. N’enregistrez jamais ce fichier dans un commit.

La plupart des systèmes de CI définissent CI, ce qui désactive le trousseau : une tâche n’attend ainsi jamais une invite. Les rapports masquent les valeurs secrètes, ils peuvent donc être conservés sans risque comme artefacts.

• Serveurs MCP avec OAuth : connectez-vous une fois sur votre Mac avec echolot mcp sign-in <server> --print, et stockez la valeur ECHOLOT_SECRET_… affichée comme secret de CI. Voir echolot mcp.
• Secrets capturés : sans trousseau, la capture d’une réponse dans une variable secrète n’est pas conservée pour la requête suivante de l’exécution. Donnez à une telle variable sa valeur depuis la CI, ou capturez dans une variable qui n’est pas secrète.

GitHub ActionsCopy Anchor Link

Sur un runner macOS, téléchargez l’outil depuis les versions et exécutez-le :

# .github/workflows/api-checks.yml
name: API checks
on: [push, pull_request]

jobs:
  echolot:
    runs-on: macos-15
    steps:
      - uses: actions/checkout@v4

      - name: Install the Echolot command-line tool
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          gh release download --repo staticdreams/echolot-public --pattern 'echolot-*-macos.zip'
          unzip -o echolot-*-macos.zip -d "$RUNNER_TEMP/echolot"
          echo "$RUNNER_TEMP/echolot" >> "$GITHUB_PATH"

      - name: Check the workspace
        run: echolot validate Alpenglow.echolot --env staging
        env:
          ECHOLOT_SECRET_PASSWORD: ${{ secrets.ALPENGLOW_STAGING_PASSWORD }}

      - name: Run the requests
        run: |
          echolot run Alpenglow.echolot --env staging \
            --reporter console --reporter junit --out echolot-results.xml
        env:
          ECHOLOT_SECRET_PASSWORD: ${{ secrets.ALPENGLOW_STAGING_PASSWORD }}

      - name: Keep the report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: echolot-results
          path: echolot-results.xml

gh release download sans tag prend la dernière version. Donnez un tag (gh release download v0.5.0 …) pour figer la version.

Runners LinuxCopy Anchor Link

L’outil tourne aujourd’hui sur macOS : la tâche ci-dessus utilise un runner macOS. Un build Linux, une image Docker et une GitHub Action prête à l’emploi ne sont pas encore publiés ; cette page les présentera quand ils le seront.

Toute autre CICopy Anchor Link

Tout est une commande avec un code de sortie : n’importe quel système de CI qui exécute des commandes shell convient. Un script pour un runner macOS :

#!/bin/sh
set -e

echolot validate Alpenglow.echolot --env staging
echolot run Alpenglow.echolot --env staging \
  --reporter console \
  --reporter junit --out reports/echolot.xml \
  --reporter html --out reports/echolot.html

set -e arrête le script à la première commande qui échoue. Pointez le réglage de rapport de tests de votre CI sur reports/echolot.xml, et conservez reports/echolot.html comme artefact que chacun peut ouvrir.

Autres garde-fousCopy Anchor Link

Pour un serveur dont l’API a besoin mais que la CI n’a pas, exécutez d’abord un mock en arrière-plan.

Voir Tester une API en CI pour un pas-à-pas à partir d’un dépôt vide.