Présentation

Déclenchez des tests Synthetic depuis vos workflows GitHub grâce à la commande CI Synthetics Datadog.

Configuration

Pour commencer :

1. Ajoutez vos clés d’API et d’application Datadog à votre référentiel GitHub sous forme de secrets. Pour en savoir plus, consultez la section Clés d’API et clés d’application.
2. Utilisez DataDog/synthetics-ci-github-action dans votre workflow GitHub.

Vous pouvez utiliser un workflow simple ou complexe.

Workflows simples

Exemple de workflow utilisant des ID publics

name: Exécuter des tests Synthetic avec des ID de test publics
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.17.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          public_ids: 'abc-d3f-ghi, jkl-mn0-pqr'

Exemple de workflow utilisant un fichier synthetics.json existant

name: Exécuter des tests Synthetic avec un fichier synthetics.json
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.17.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}

Pour consulter un exemple de test, référez-vous au fichier test.synthetics.json.

Remarque : par défaut, ce workflow exécute tous les tests répertoriés dans les fichiers {,!(node_modules)/**/}*.synthetics.json (à savoir, tous les fichiers qui se termine par .synthetics.json, sauf ceux contenus dans le dossier node_modules). Vous pouvez également déclencher une liste de tests Synthetic en spécifiant un public_id ou en utilisant une requête de recherche.

Workflows complexes

Exemple de workflow utilisant une requête test_search_query

name: Exécuter des tests Synthetic en fonction des tags de test
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.17.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          test_search_query: 'tag:e2e-tests'

Exemple de workflow utilisant une requête de recherche de test et des remplacements de variables

name: Exécuter des tests Synthetic avec une requête de recherche
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.17.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          test_search_query: 'tag:staging'
          variables: 'START_URL=https://staging.website.com,PASSWORD=stagingpassword'

Exemple de workflow utilisant un remplacement de la configuration globale avec config_path

Cette action GitHub remplace le chemin vers le fichier datadog-ci.config.json global.

name: Exécuter des tests Synthetic avec une configuration
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.17.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          config_path: './synthetics-config.json'

Pour consulter un exemple de test, référez-vous au fichier global.config.json.

Paramètres

Développement

yarn jest

# Créer le projet
yarn build

# Compiler le projet et ses dépendances afin de le publier
yarn package

Processus de publication

Pour publier une nouvelle version de synthetics-ci-github-action, procédez comme suit :

1. Créez une nouvelle branche pour la mise à niveau de la version.

2. Mettez à jour la version du package à l’aide de yarn version [--patch|--minor|--major], en adaptant la commande selon la nature des changements. Consultez la section relative à la gestion sémantique des versions pour déterminer ce que vous devez incrémenter. Une fois la commande yarn version exécutée, un nouveau commit vX.Y.Z doté d’un nouveau tag est ajouté à l’arborescence Git.

3. Mettez à jour les exemples de version de README.md, puis exécutez yarn build && yarn package pour générer et packager le projet.

   Assurez-vous d’utiliser le commit contenant le tag vX.Y.Z pour soumettre ces changements. Pour fusionner les changements au sein d’un seul et même commit, utilisez la commande git commit --amend ou la commande git rebase -i HEAD~2.

4. Envoyez la branche ainsi que le tag de version (git push --tags) en amont (à GitHub).

   Créez une pull request en indiquant dans la description les modifications apportées. Cette pull request doit au moins être approuvée une fois.

5. Fusionnez la pull request.

6. Créez une version GitHub depuis la page Tags, en prenant soin de décrire vos changements.

⚠️ Vérifiez que le numéro de version respecte le format attendu : vX.Y.Z.

Une fois ce processus terminé, la nouvelle version de l’action GitHub est disponible en tant que workflow.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles :

• Configuration des tests continus et du CI/CD
• Conseils à suivre pour effectuer des tests continus avec Datadog